Skip to main content
PUT
/
alerts
/
statuses
/
{key}
curl -X PUT 'https://api.cloud.blnkfinance.com/alerts/statuses/PENDING_REVIEW' \
  -H 'Authorization: Bearer YOUR_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"
}

Documentation Index

Fetch the complete documentation index at: https://guide.cloud.blnkfinance.com/llms.txt

Use this file to discover all available pages before exploring further.

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

​
Request structure

curl -X PUT 'https://api.cloud.blnkfinance.com/alerts/statuses/PENDING_REVIEW' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Awaiting Review",
    "colour": "#10B981"
  }'
​
key
string
The status key to update (e.g. PENDING_REVIEW). Case-insensitive.
​
name
string
required
New display name for the status.
​
colour
string
required
New hex colour code. Must be one of the values in allowed_colours from the list statuses response.

​
Response structure

{
  "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"
}
​
organization_id
string
required
Organization ID that owns the status.
​
key
string
required
The status key.
​
name
string
required
Display name of the status (after update).
​
colour
string
required
Hex colour code of the status (after update).
​
created_at
timestamp
required
ISO 8601 timestamp when the status was created.
​
updated_at
timestamp
required
ISO 8601 timestamp when the status was last updated.

​
Need help?

If you’re having trouble with Blnk Cloud, don’t hesitate to send us a message via email at support@blnkfinance.com or send us a message here.