Skip to main content
PUT
/
v2
/
alert_attributes
/
{id}
Update
curl --request PUT \
  --url https://api.incident.io/v2/alert_attributes/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "array": false,
  "emoji": "fire",
  "name": "service",
  "required": false,
  "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]"
}
'
{
  "alert_attribute": {
    "array": false,
    "emoji": "fire",
    "id": "01GW2G3V0S59R238FAHPDS1R66",
    "name": "service",
    "required": false,
    "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

The ID of this attribute

Example:

"01GW2G3V0S59R238FAHPDS1R66"

Body

application/json
​
array
boolean
required

Whether this attribute is an array

Example:

false

​
name
string
required

Unique name of this attribute

Example:

"service"

​
type
string
required

Engine resource name for this attribute

Example:

"CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]"

​
emoji
string

The emoji to display alongside this attribute in chat messages, stored without colons

Example:

"fire"

​
required
boolean

Whether this attribute is required. If this field is not set, the existing setting will be preserved.

Example:

false

Response

200 - application/json

OK response.

​
alert_attribute
object
required
Example:
{
  "array": false,
  "emoji": "fire",
  "id": "01GW2G3V0S59R238FAHPDS1R66",
  "name": "service",
  "required": false,
  "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]"
}