Alerts
Create alert status
Create a custom alert status with a display name and colour.
POST
/
alerts
/
statuses
curl -X POST 'https://api.cloud.blnkfinance.com/alerts/statuses' \
-H 'X-blnk-key: CLOUD_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"
}
{
"error": "Key: 'CreateStatusRequest.Name' Error:Field validation for 'Name' failed on the 'required' tag\nKey: 'CreateStatusRequest.Colour' Error:Field validation for 'Colour' failed on the 'required' tag"
}
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.
Authorization
Blnk Cloud APIs support any one of the following authentication methods. All of them work with yourCLOUD_API_KEY or OAUTH_ACCESS_TOKEN.
Pass X-blnk-key: CLOUD_API_KEY or X-blnk-key: OAUTH_ACCESS_TOKEN.
Body
curl -X POST 'https://api.cloud.blnkfinance.com/alerts/statuses' \
-H 'X-blnk-key: CLOUD_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"name": "Pending Review",
"colour": "#3B82F6"
}'
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
{
"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"
}
{
"error": "Key: 'CreateStatusRequest.Name' Error:Field validation for 'Name' failed on the 'required' tag\nKey: 'CreateStatusRequest.Colour' Error:Field validation for 'Colour' failed on the 'required' tag"
}
string
Organization ID that owns the status.
string
The status key (supplied or derived from name).
string
Display name of the status.
string
Hex colour code of the status.
timestamp
ISO 8601 timestamp when the status was created.
timestamp
ISO 8601 timestamp when the status was last updated.
Need help?
We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool. To ask questions or discuss issues, please contact us or join our Discord community.Was this page helpful?
⌘I
curl -X POST 'https://api.cloud.blnkfinance.com/alerts/statuses' \
-H 'X-blnk-key: CLOUD_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"
}
{
"error": "Key: 'CreateStatusRequest.Name' Error:Field validation for 'Name' failed on the 'required' tag\nKey: 'CreateStatusRequest.Colour' Error:Field validation for 'Colour' failed on the 'required' tag"
}