Sign in
latestSwagger 2.02026-08-102194011.3 MB

602fc25ddd76

Incident Roles V1

Update Incident Roles V1

Update an existing incident role

put/v1/incident_roles/{id}

Path parameters

idstring required

Unique identifier for the role

Request body

descriptionstring required

Describes the purpose of the role

instructionsstring required

Provided to whoever is nominated for the role. Note that this will be empty for the 'reporter' role.

namestring required

Human readable name of the incident role

requiredboolean

DEPRECATED: this will always be false.

shortformstring required

Short human readable name for Slack. Note that this will be empty for the 'reporter' role.

Example request

{
  "description": "The person currently coordinating the incident",
  "instructions": "Take point on the incident; Make sure people are clear on responsibilities",
  "name": "Incident Lead",
  "required": false,
  "shortform": "lead"
}

Response

OK response.

Example response

{
  "incident_role": {
    "created_at": "2021-08-17T13:28:57.801578Z",
    "description": "The person currently coordinating the incident",
    "id": "01FCNDV6P870EA6S7TK1DSYDG0",
    "instructions": "Take point on the incident; Make sure people are clear on responsibilities",
    "name": "Incident Lead",
    "required": false,
    "role_type": "lead",
    "shortform": "lead",
    "updated_at": "2021-08-17T13:28:57.801578Z"
  }
}