Skip to navigation

Delete Alert

View as Markdown

Delete an alert.

Available to: Traders (own alerts); organization administrators (any user in their organization)

Environments: Demo, Live

Rate Limit: No endpoint-specific limit

Remove the alert identified by alertId. The server archives the alert and stops watching its condition. On success, the response has no alert and no errorText.

To stop an alert but keep it, call dismissAlert instead; you can re-arm it later with resetAlert.

Common Failure Scenarios

  • The alertId is for an alert you can’t access. This returns HTTP 401 with "Access is denied".
  • No alert matches alertId. This returns HTTP 404 with an empty body.
  • alertId isn’t greater than 0. This returns HTTP 400.
  • The alert service is temporarily unavailable. This returns HTTP 503.
  • The caller’s user type, or the API key’s permissions, don’t include full access to the Alerts resource. This returns HTTP 401 with "Access is denied".
  • Archiving the alert fails unexpectedly. This returns HTTP 200 with the reason in errorText.

This endpoint returns HTTP 200 for both successful and rejected requests, so check the errorText field to confirm the result. Other failures, such as denied access or an invalid request, return their own HTTP status.

Error Messages

MessageResponseTrigger
"Alert Id should be greater than 0"400alertId isn’t greater than 0.
"Access is denied"401The caller’s user type, or the API key’s permissions, don’t include full access to the Alerts resource.
"Access is denied"401The alertId is for an alert the caller can’t access.
(no message text)404No alert matches alertId.
"Service Unavailable, error id: {id}"503The alert service is temporarily unavailable. The error ID is generated per request.
"Internal Error. Error ID: {id}"200 (in errorText)Archiving the alert failed unexpectedly. The error ID is generated per request.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
alertIdlongRequired

Response

AlertResponse
errorTextstringOptional<=8192 characters

Non-empty if the request failed

alertobjectOptional