Skip to navigation

Dismiss Alert

View as Markdown

Dismiss an alert, leaving it in place for later reset.

Available to: All authenticated users

Environments: Demo, Live

Rate Limit: No endpoint-specific limit

Stops watching the alert identified by alertId and sets its status to Inactive. The alert must belong to the calling user. Dismissing keeps the alert entity, so it is not removed — it simply stops evaluating its condition. To start it watching again, use resetAlert (which also clears the trigger counter and any failure). To remove the alert entirely, use deleteAlert.

The request body contains a single required field, alertId, from createAlert or alertItem. The response returns the dismissed alert. Dismiss is idempotent: dismissing an alert that is already Inactive returns the alert unchanged.

Common Failure Scenarios

  • alertId does not exist or is not owned by the calling user.

Error Messages

errorTextTrigger
Non-empty errorTextThe 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
errorTextstringOptional<=8192 characters

Non-empty if the request failed

alertobjectOptional