Sign in

v66

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-04176310979.2 KB
incidents

Update Incident

Update an existing incident

put/api/v1/incidents/

Request body

descriptionstring required

Description of the service incident

start_datetimestring date-time required

Start time of the incident

resolution_datetimestring date-time required

Resolution time of the incident

impact_categorystring required

Category of the impact

sessions_impactedinteger required

Number of sessions impacted

markdownstring required

Detailed markdown description of the incident

organization_idinteger nullable

The ID of the organization

sub_organization_idinteger nullable

The ID of the sub-organization

sub_organizationstring nullable

The name of the sub-organization (DEPRECATED)

idinteger required

The ID of the incident to update

Example request

{
  "description": "Service outage in region X",
  "start_datetime": "2023-10-01T08:00:00Z",
  "resolution_datetime": "2023-10-01T12:00:00Z",
  "impact_category": "High",
  "sessions_impacted": 1500,
  "markdown": "**Incident Details**",
  "organization_id": 123,
  "sub_organization_id": 456,
  "sub_organization": "SubOrg A",
  "id": 1
}

Response

Successful Response

descriptionstring required

Description of the service incident

start_datetimestring date-time required

Start time of the incident

resolution_datetimestring date-time required

Resolution time of the incident

impact_categorystring required

Category of the impact

sessions_impactedinteger required

Number of sessions impacted

markdownstring required

Detailed markdown description of the incident

organization_idinteger nullable

The ID of the organization

sub_organization_idinteger nullable

The ID of the sub-organization

sub_organizationstring nullable

The name of the sub-organization (DEPRECATED)

idinteger required

The ID of the incident to update

created_atstring date-time nullable

Creation time of the incident

updated_atstring date-time nullable

Last update time of the incident

last_updated_bystring nullable required

The email of the user who last updated the incident

Example response

{
  "description": "Service outage in region X",
  "start_datetime": "2023-10-01T08:00:00Z",
  "resolution_datetime": "2023-10-01T12:00:00Z",
  "impact_category": "High",
  "sessions_impacted": 1500,
  "markdown": "**Incident Details**",
  "organization_id": 123,
  "sub_organization_id": 456,
  "sub_organization": "SubOrg A",
  "id": 1,
  "created_at": "2023-10-01T08:00:00Z",
  "updated_at": "2023-10-01T08:00:00Z",
  "last_updated_by": "user@mail.com"
}