Skip to main content
PUT
/
v2
/
incident_roles
/
{id}
Update
curl --request PUT \
  --url https://api.incident.io/v2/incident_roles/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "The person currently coordinating the incident",
  "instructions": "Take point on the incident; Make sure people are clear on responsibilities",
  "name": "Incident Lead",
  "shortform": "lead"
}
'
{
  "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",
    "role_type": "lead",
    "shortform": "lead",
    "updated_at": "2021-08-17T13:28:57.801578Z"
  }
}

Path Parameters

​
id
string
required

Unique identifier for the role

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

Body

application/json
​
description
string
required

Describes the purpose of the role

Minimum string length: 1
Example:

"The person currently coordinating the incident"

​
instructions
string
required

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

Example:

"Take point on the incident; Make sure people are clear on responsibilities"

​
name
string
required

Human readable name of the incident role

Minimum string length: 1
Example:

"Incident Lead"

​
shortform
string
required

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

Example:

"lead"

Response

200 - application/json

OK response.

​
incident_role
object
required
Example:
{
  "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",
  "role_type": "lead",
  "shortform": "lead",
  "updated_at": "2021-08-17T13:28:57.801578Z"
}