Incidents Update

POST

Updates an incident.

Request

This endpoint expects an object.
idstringRequired

The ID of the incident to be updated.

acknowledged_datedatetimeOptional

Timestamp when the incident was acknowledged.

applies_to_partsobjectOptional
artifactsobjectOptional
bodystringOptional

Body of the incident.

custom_fieldsmap from strings to anyOptional

Application-defined custom fields.

custom_schema_specobjectOptional

Requested custom schemas described abstractly. Every provided schema’s custom field must be specified, otherwise a bad request error is returned. If a new custom schema specifier is provided, then it will be added to the work, otherwise if a custom schema is omitted from the specifier, it remains unmodified.

identified_datedatetimeOptional

Time when the incident was identified/reported.

impactobjectOptional
impacted_customersobjectOptional
mitigated_datedatetimeOptional

Timestamp when the incident was mitigated.

owned_byobjectOptional
piaobjectOptional
playbooksobjectOptional
related_docsobjectOptional
reported_bylongOptional

The entity that first reported the incident.

severitylongOptional

Severity of the incident.

sourcelongOptional

Source of where the incident was created. Only sys users and service accounts are supposed to set this field.

stageobjectOptional

Update object for Stage.

stakeholdersobjectOptional
tagsobjectOptional
target_close_datedatetimeOptional

Timestamp when the incident is expected to be resolved.

titlestringOptional

Title of the incident.

Response

This endpoint returns an object.
incidentobject