Skip to main content
PUT
Update
🔑 Requires the organisation_settings.update scope.

Authorizations

Authorization
string
header
required

API key from your incident.io dashboard (Settings → API keys)

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