Skip to main content
POST
/
alerts
/
statuses
curl -X POST 'https://api.cloud.blnkfinance.com/alerts/statuses' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Pending Review",
    "colour": "#3B82F6"
  }'

{
  "organization_id": "org_01ABC123",
  "key": "PENDING_REVIEW",
  "name": "Pending Review",
  "colour": "#3B82F6",
  "created_at": "2025-01-29T14:00:00Z",
  "updated_at": "2025-01-29T14:00: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.

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

curl -X POST 'https://api.cloud.blnkfinance.com/alerts/statuses' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Pending Review",
    "colour": "#3B82F6"
  }'
​
name
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.
​
colour
string
required
Hex colour code for the status. Must be one of the values in allowed_colours from the list statuses response.
​
key
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

{
  "organization_id": "org_01ABC123",
  "key": "PENDING_REVIEW",
  "name": "Pending Review",
  "colour": "#3B82F6",
  "created_at": "2025-01-29T14:00:00Z",
  "updated_at": "2025-01-29T14:00:00Z"
}
​
organization_id
string
required
Organization ID that owns the status.
​
key
string
required
The status key (supplied or derived from name).
​
name
string
required
Display name of the status.
​
colour
string
required
Hex colour code of the status.
​
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.