This feature is only available in the Enterprise version

Alerts

Update alert

Update the details of an existing alert.

PUT/alerts/flag/{alert_id}

Update an existing alert to modify its details, add context, or reflect workflow progression.

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

alert_idstringrequiredpath

Unique identifier of the alert you want to update. Must be a valid alert ID.

Body

titlestringbody

Updated title for the alert.

descriptionstringbody

Updated description of the alert.

statusstringbody

Updated status of the alert.

Response

anomaly_idstring

Unique identifier for the alert.

titlestring

The updated title of the alert, if provided.

descriptionstring

The updated description of the alert.

typestring

The type or category of the alert (e.g., “Balance”, “Transaction”, “Identity”).

assigned_tostring

The name or identifier of the user assigned to handle the alert.

escalated_toarray

Array of user identifiers to whom the alert has been escalated.

statusstring

The current status of the alert (e.g., “FLAGGED”).

created_attimestamp

ISO 8601 formatted timestamp of when the alert was created.

updated_attimestamp

ISO 8601 formatted timestamp of when the alert was last updated.

affected_balancesarray

Array of balance IDs affected by this alert.

affected_identitiesarray

Array of identity IDs affected by this alert.

affected_transactionsarray

Array of transaction IDs affected by this alert.