Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Incidents

Update Incident

Use this API to update the details of a specific incident by providing the incident's unique ID in the URL path and the updated information in the request body. The response will return the updated incident information.

put/incident/v1/incidents/{incidentId}

Path parameters

incidentIdstring uuid required

Incident ID

Example:f7114aef-b6b6-42d6-9249-56a467950aa7

ID of an incident. The value can be obtained using Create Incident API.

Request body

namestring required

Name of the incident. Provide a descriptive name to the incident so that it can be quickly referenced in the incident register.

descriptionstring

Brief description of the incident.

incidentTypeNamestring required

The name of the type of incident that has occurred.

orgGroupIdstring uuid required

Incident Organization ID. This can be retrieved from the Get List of Organizations API.

dateOccurredstring date-time

The date and time when the incident occurred, represented as an ISO 8601 timestamp in UTC.

dateDiscoveredstring date-time

The date and time when the incident was discovered, represented as an ISO 8601 timestamp in UTC.

deadlinestring date-time

The date by which the incident investigation or notification must be completed, represented as an ISO 8601 timestamp in UTC.

sourceType'MANUAL' | 'ASSESSMENT' | 'WEBFORM' | 'INTEGRATION'
rootCausestring

The root cause summary of the incident.

notificationNeeded'YES' | 'NO' | 'UNKNOWN'
attributeValuesobject

A map of custom attribute field names to the list of values associated with each attribute. Each entry in the list can contain either an 'id' (for predefined options) or a 'value', depending on the attribute configuration. If any attribute value is missing in the JSON array, the existing value for that attribute will be overridden, and the attribute will have empty values.

Example request

{
  "name": "Joe sent an email to the wrong client",
  "description": "An employee accessed a restricted HR file without proper authorization.\nAccess logs confirmed the breach, and the user’s permissions were immediately revoked.\n",
  "incidentTypeName": "Misdirected Email",
  "orgGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "dateOccurred": "2019-05-31T12:43:24.173Z",
  "dateDiscovered": "2019-05-31T15:00:00.000Z",
  "deadline": "2019-07-31T12:43:24.173Z",
  "sourceType": "INTEGRATION",
  "rootCause": "The root cause was traced to a lack of validation in the email recipient auto-fill feature,\nleading to sensitive data being sent to the wrong external recipient.\n",
  "notificationNeeded": "YES",
  "attributeValues": {
    "customTextAttributeFieldName": [
      {
        "value": "Attribute Value"
      }
    ],
    "customSingleSelectAttributeFieldName": [
      {
        "value": "Option Value 1"
      }
    ],
    "customMultiSelectAttributeFieldName": [
      {
        "value": "Option Value 2"
      },
      {
        "value": "Option Value 3"
      }
    ]
  },
  "incidentAssigneeRequests": [
    {
      "assigneeId": "550e8400-e29b-41d4-a716-446655440000",
      "assigneeEmail": "user@example.com",
      "type": "USER"
    }
  ],
  "jurisdictions": [
    {
      "jurisdictionId": "123e4567-e89b-12d3-a456-426614174000",
      "stateProvinceCode": "CA"
    }
  ]
}

Response

OK

idstring uuid

Incident Identifier

numberinteger

Incident Number

incidentTypeIdstring uuid

The unique identifier for the incident type.

incidentTypeNamestring

The name of the incident type.

namestring

Incident Name

descriptionstring

Incident Description

sourceType'MANUAL' | 'ASSESSMENT' | 'WEBFORM' | 'NONE' | 'INTEGRATION'

Creation Source

orgGroupIdstring uuid

Organization Group Id

orgGroupNamestring

Organization Group Name

rootCausestring

Root Cause

dateOccurredstring date-time

The date and time when the incident occurred, represented as an ISO 8601 timestamp in UTC.

dateClosedstring date-time

The date and time when the incident was closed, represented as an ISO 8601 timestamp in UTC.

dateDiscoveredstring date-time

The date and time when the incident was discovered, represented as an ISO 8601 timestamp in UTC.

deadlinestring date-time

The date by which the incident investigation or notification must be completed, represented as an ISO 8601 timestamp in UTC.

createdBystring uuid

Incident Created User Id.

creatorstring

Incident Created User Name

assigneeIdstring uuid

Incident User Assignee Id

assigneeNamestring

Incident User Assignee Name

createdDTstring date-time

The date and time when the incident was created, represented as an ISO 8601 timestamp in UTC.

workflowIdstring uuid

Incident Workflow Id

workflowNamestring

Incident Workflow Name.

incidentStageIdstring uuid

Incident Stage Id

incidentStageNamestring

Incident Stage Name

incidentStageBadgeColorstring

The badge color of the incident workflow stage.

notificationNeeded'YES' | 'NO' | 'UNKNOWN'

Incident Notification Needed

incidentStatus'OPEN' | 'CLOSED'
schemaIdstring uuid

The unique identifier of the custom attribute schema associated with the incident.

updatedDTstring date-time

The date and time when the incident was last updated, represented as an ISO 8601 timestamp in UTC.

attributeValuesobject

Custom Attributes

closedSettingOnboolean

Example response

{
  "id": "1d429adf-26c5-413b-9b01-e7845a5dde99",
  "number": 1,
  "incidentTypeName": "Misdirected Email",
  "name": "Joe sent an email to the wrong client",
  "description": "An employee accessed a restricted HR file without proper authorization.\nAccess logs confirmed the breach, and the user’s permissions were immediately revoked.\n",
  "sourceType": "INTEGRATION",
  "assessmentLinks": [
    {
      "assessmentName": "Incident Assessment",
      "assessmentStatus": "IN_PROGRESS"
    }
  ],
  "orgGroupName": "Business Unit",
  "rootCause": "The root cause was traced to a lack of validation in the email recipient auto-fill feature,\nleading to sensitive data being sent to the wrong external recipient.\n",
  "dateOccurred": "2025-04-21T05:22:40.187Z",
  "dateClosed": "2025-04-28T05:22:40.187Z",
  "dateDiscovered": "2025-04-21T12:22:40.187Z",
  "deadline": "2025-04-23T05:22:40.187Z",
  "creator": "User Name",
  "assigneeName": "User Name",
  "createdDT": "2025-04-21T14:10:00.187Z",
  "workflowName": "Default Workflow",
  "incidentStageName": "Investigating",
  "incidentStageBadgeColor": "InProgress",
  "incidentStatus": "OPEN",
  "updatedDT": "2025-04-28T05:22:40.187Z",
  "attributeValues": {
    "customTextAttributeFieldName": [
      {
        "value": "Attribute Value",
        "disabled": false
      }
    ],
    "customSingleSelectAttributeFieldName": [
      {
        "id": "0f5afc29-7fe1-4145-b541-ac33158312b6",
        "value": "Option Value 1",
        "disabled": false
      }
    ],
    "customMultiSelectAttributeFieldName": [
      {
        "id": "736a8cb4-4e0e-4938-a43f-74edbaf46c0a",
        "value": "Option Value 2",
        "disabled": false
      },
      {
        "id": "b4e17ed9-5e11-44f8-bb20-100af4d9e39b",
        "value": "Option Value 3",
        "disabled": false
      }
    ]
  },
  "incidentAssigneeInformation": [
    {
      "assigneeName": "User Name"
    }
  ],
  "jurisdictions": [
    {
      "regionName": "Americas",
      "countryName": "United States of America",
      "countryCode": "USA",
      "stateProvinceName": "California",
      "stateProvinceCode": "CA",
      "urgency": "HIGH",
      "notifyIndividual": "NOTIFICATION_REQUIRED",
      "notifyAuthority": "NOTIFICATION_REQUIRED",
      "numberOfGuidances": 2,
      "numberOfAcceptedGuidances": 1,
      "numberOfAddressedGuidances": 1
    }
  ]
}