Update alert status

PUT

alerts

statuses

{key}

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

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

Authorization

Blnk Cloud APIs support any one of the following authentication methods. All of them work with your CLOUD_API_KEY or OAUTH_ACCESS_TOKEN.

Bearer token
X-Blnk-Key header
X-API-Key header

Pass Authorization: Bearer CLOUD_API_KEY or Authorization: Bearer OAUTH_ACCESS_TOKEN.

string

required

Cloud API key or OAuth access token. Create credentials in API keys or OAuth.

Pass X-Blnk-Key: CLOUD_API_KEY or X-Blnk-Key: OAUTH_ACCESS_TOKEN.

string

required

Cloud API key or OAuth access token. Create credentials in API keys or OAuth.

Pass X-API-Key: CLOUD_API_KEY or X-API-Key: OAUTH_ACCESS_TOKEN.

string

required

Cloud API key or OAuth access token. Create credentials in API keys or OAuth.

Path

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

string

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

Body

string

required

New display name for the status.

string

required

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

Response

{
  "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"
}

string

Organization ID that owns the status.

string

The status key.

string

Display name of the status (after update).

string

Hex colour code of the status (after update).

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.

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

Start Here

Deployments

Proxy & data

Data lake

AI integrations

Audit

Alerts

Billing

Authorization

Path

Body

Response

Need help?

​Authorization

​Path

​Body

​Response

​Need help?

Authorization

Path

Body

Response

Need help?