Skip to main content
PUT
/
api
/
v1
/
incidents
Typescript (SDK)
import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.incidents.update({
    description: "Service outage in region X",
    startDatetime: new Date("2023-10-01T08:00:00Z"),
    resolutionDatetime: new Date("2023-10-01T12:00:00Z"),
    impactCategory: "High",
    sessionsImpacted: 1500,
    markdown: "**Incident Details**",
    organizationId: 123,
    subOrganizationId: 456,
    id: 1,
  });

  console.log(result);
}

run();
{
  "description": "<string>",
  "start_datetime": "2023-11-07T05:31:56Z",
  "resolution_datetime": "2023-11-07T05:31:56Z",
  "impact_category": "<string>",
  "sessions_impacted": 123,
  "markdown": "<string>",
  "id": 123,
  "last_updated_by": "user@mail.com",
  "organization_id": 123,
  "sub_organization_id": 456,
  "sub_organization": "SubOrg A",
  "created_at": "2023-10-01T08:00:00Z",
  "updated_at": "2023-10-01T08:00:00Z"
}

Authorizations

Syllable-API-Key
string
header
required

Body

application/json

Request model to update an existing service incident.

description
string
required

Description of the service incident

Example:

"Service outage in region X"

start_datetime
string<date-time>
required

Start time of the incident

Example:

"2023-10-01T08:00:00Z"

resolution_datetime
string<date-time>
required

Resolution time of the incident

Example:

"2023-10-01T12:00:00Z"

impact_category
string
required

Category of the impact

Example:

"High"

sessions_impacted
integer
required

Number of sessions impacted

Example:

1500

markdown
string
required

Detailed markdown description of the incident

Example:

"**Incident Details**"

id
integer
required

The ID of the incident to update

Example:

1

organization_id
integer | null

The ID of the organization

Example:

123

sub_organization_id
integer | null

The ID of the sub-organization

Example:

456

sub_organization
string | null
deprecated

The name of the sub-organization (DEPRECATED)

Example:

"SubOrg A"

Response

Successful Response

Response model for service incident operations.

description
string
required

Description of the service incident

Example:

"Service outage in region X"

start_datetime
string<date-time>
required

Start time of the incident

Example:

"2023-10-01T08:00:00Z"

resolution_datetime
string<date-time>
required

Resolution time of the incident

Example:

"2023-10-01T12:00:00Z"

impact_category
string
required

Category of the impact

Example:

"High"

sessions_impacted
integer
required

Number of sessions impacted

Example:

1500

markdown
string
required

Detailed markdown description of the incident

Example:

"**Incident Details**"

id
integer
required

The ID of the incident to update

Example:

1

last_updated_by
string | null
required

The email of the user who last updated the incident

Example:

"user@mail.com"

organization_id
integer | null

The ID of the organization

Example:

123

sub_organization_id
integer | null

The ID of the sub-organization

Example:

456

sub_organization
string | null
deprecated

The name of the sub-organization (DEPRECATED)

Example:

"SubOrg A"

created_at
string<date-time> | null

Creation time of the incident

Example:

"2023-10-01T08:00:00Z"

updated_at
string<date-time> | null

Last update time of the incident

Example:

"2023-10-01T08:00:00Z"