Alerts

Delete alert status

Delete a custom alert status by key.

DEL/alerts/statuses/{key}

Delete a custom alert status by key. The request fails if any alerts in the organization still use this status; reassign those alerts to another status first.

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

keystringrequiredpath

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

Response

messagestring

Confirmation message when the status is deleted.

Error when status is in use

If one or more alerts still use this status, the API returns an error and does not delete the status:

Reassign those alerts (e.g. via Update alert) to another status, then call delete again.

curl -X DELETE 'https://api.cloud.blnkfinance.com/alerts/statuses/PENDING_REVIEW' \
  -H 'X-blnk-key: CLOUD_API_KEY'

{
  "message": "Status deleted"
}

{
  "error": "cannot delete status: 3 alert(s) use this status - reassign them to another status first"
}

{
  "error": "status not found: UNKNOWN_STATUS"
}