Skip to navigation

Mark Read Alert Signal

View as Markdown

Mark an alert signal as read.

Available to: All authenticated users

Environments: Demo, Live

Rate Limit: No endpoint-specific limit

Marks an alert signal as read, setting its isRead flag to true. An alert signal is a single trigger event produced by an alert — the moment the alert’s condition was met. Marking it read acknowledges that the user has seen the notification. Identify the signal with alertSignalId (the integer entity ID); supply the owning alert’s ID in alertId.

To look up the parent alert, query alertItem or alertItems.

On success, the response returns with an empty errorText. On a handled failure, the response carries a non-empty errorText describing the problem.

Common Failure Scenarios

  • The alertSignalId doesn’t exist or isn’t accessible to the caller.
  • The access token is missing or invalid (returns HTTP 401).

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
alertSignalIdlongRequired

Response

AlertResponse
errorTextstringOptional<=8192 characters

Non-empty if the request failed

alertobjectOptional