Alerts
Create alert status
Create a custom alert status with a display name and colour.
POST
Create a custom alert status with a display name and colour. Statuses are per organization and can be used when updating an alert’s status.
Request structure
string
required
Display name for the status (e.g. “Pending Review”, “In Progress”). If key is omitted, a key is derived from this (e.g. “Pending Review” → PENDING_REVIEW). Names must be unique per org when key is auto-derived.
string
required
Hex colour code for the status. Must be one of the values in allowed_colours from the list statuses response.
string
Optional. Custom key for the status (e.g. PENDING_REVIEW). If omitted, a key is derived from name. Must be unique per organization.
Response structure
string
required
Organization ID that owns the status.
string
required
The status key (supplied or derived from name).
string
required
Display name of the status.
string
required
Hex colour code of the status.
timestamp
required
ISO 8601 timestamp when the status was created.
timestamp
required
ISO 8601 timestamp when the status was last updated.