Alerts

Update alert status

Update a custom alert status's name and/or colour.

PUT/alerts/statuses/{key}

Update a custom alert status’s name and/or colour. The status is identified by its key.

Enterprise authentication

Send these requests to https://api.cloud.blnkfinance.com on Blnk Cloud. On a self-hosted Enterprise deployment, send them to ENTERPRISE_PUBLIC_URL.

Pass an Enterprise API key, or an OAuth access token, in the X-blnk-key header. Create the key in Enterprise API keys, or issue a token with Enterprise OAuth.

This credential comes from the Cloud or Enterprise workspace. A Core API key belongs to the Core instance.

X-blnk-keystringrequiredheader

Enterprise API key, or an OAuth access token.

Path

keystringpath

The status key to update (e.g. PENDING_REVIEW). Case-insensitive.

Body

namestringrequiredbody

New display name for the status.

colourstringrequiredbody

New hex colour code. Must be one of the values in allowed_colours from the list statuses response.

Response

organization_idstring

Organization ID that owns the status.

keystring

The status key.

namestring

Display name of the status (after update).

colourstring

Hex colour code of the status (after update).

created_attimestamp

ISO 8601 timestamp when the status was created.

updated_attimestamp

ISO 8601 timestamp when the status was last updated.

curl -X PUT 'https://api.cloud.blnkfinance.com/alerts/statuses/PENDING_REVIEW' \
  -H 'X-blnk-key: CLOUD_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Awaiting Review",
    "colour": "#10B981"
  }'

{
  "organization_id": "org_01ABC123",
  "key": "PENDING_REVIEW",
  "name": "Awaiting Review",
  "colour": "#10B981",
  "created_at": "2025-01-29T14:00:00Z",
  "updated_at": "2025-01-29T14:30:00Z"
}