Alerts
Delete alert status
Delete a custom alert status by key.
DELETE
/
alerts
/
statuses
/
{key}
curl -X DELETE 'https://api.cloud.blnkfinance.com/alerts/statuses/PENDING_REVIEW' \
-H 'X-blnk-key: CLOUD_API_KEY'
{
"message": "Status deleted"
}
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.
Reassign those alerts (e.g. via Update alert) to another status, then call delete again.
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.
Path
curl -X DELETE 'https://api.cloud.blnkfinance.com/alerts/statuses/PENDING_REVIEW' \
-H 'X-blnk-key: CLOUD_API_KEY'
string
required
The status key to delete (e.g. PENDING_REVIEW). Case-insensitive.
Response
{
"message": "Status deleted"
}
string
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:{
"error": "cannot delete status: 3 alert(s) use this status - reassign them to another status first"
}
{
"error": "status not found: UNKNOWN_STATUS"
}
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 DELETE 'https://api.cloud.blnkfinance.com/alerts/statuses/PENDING_REVIEW' \
-H 'X-blnk-key: CLOUD_API_KEY'
{
"message": "Status deleted"
}