Delete Alert

View as Markdown
### Delete an alert owned by the authenticated user. **Available to:** All authenticated users **Environments:** Demo, Live **[Rate Limit](/api/authentication#request-rate-limits-and-time-penalties):** No endpoint-specific limit Removes the alert identified by `alertId`. The alert must belong to the calling user. The server archives the alert and stops watching its condition, so the alert no longer appears in [`alertItem`](/api/rest-api-endpoints/alerts/alert-item) or list reads and cannot be reset afterward. To stop an alert without removing it — so it can be re-armed later — use [`dismissAlert`](/api/rest-api-endpoints/alerts/dismiss-alert) followed by [`resetAlert`](/api/rest-api-endpoints/alerts/reset-alert) instead. The request body contains a single required field, `alertId`, from [`createAlert`](/api/rest-api-endpoints/alerts/create-alert) or [`alertItem`](/api/rest-api-endpoints/alerts/alert-item). On success the response returns no `alert`; an empty `errorText` indicates the alert was removed. **Common Failure Scenarios** - `alertId` does not exist or is not owned by the calling user. This action cannot be undone. To keep the alert available for future use, dismiss it instead of deleting it. **Error Messages** | `errorText` | Trigger | |-------------|---------| | Non-empty `errorText` | The request failed; the field describes the reason. |

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
alertIdlongRequired

Response

AlertResponse
errorTextstring<=8192 characters

Non-empty if the request failed

alertobject