Delete Alert
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
alertIdis for an alert you can’t access. This returnsHTTP 401with"Access is denied". - No alert matches
alertId. This returnsHTTP 404with an empty body. alertIdisn’t greater than 0. This returnsHTTP 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
Alertsresource. This returnsHTTP 401with"Access is denied". - Archiving the alert fails unexpectedly. This returns
HTTP 200with the reason inerrorText.
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
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
Response
Non-empty if the request failed