Skip to navigation
REST API EndpointsAlerts

Take Alert Signal Ownership

View as Markdown

Claim ownership of an admin alert signal for handling.

Available to: All authenticated users

Environments: Demo, Live

Rate Limit: No endpoint-specific limit

Claims an admin alert signal so the calling user becomes responsible for working it. An admin alert signal is an internal alerting record that flags a situation for staff or B2B partner follow-up (for example, a signal related to a specific account or user). Taking ownership records the caller as the owner and stamps the time the signal was claimed, so the same signal isn’t worked twice. Identify the signal with adminAlertSignalId (the integer entity ID).

A signal tied to a public admin alert cannot be owned — ownership applies only to signals that require individual handling.

On success, the response returns the updated adminAlertSignal reflecting the new owner and an empty errorText. On a handled failure, the response carries a non-empty errorText describing the problem.

Common Failure Scenarios

  • The signal belongs to a public admin alert, which cannot be owned.
  • The adminAlertSignalId doesn’t exist or isn’t accessible to the caller.
  • The access token is missing or invalid (returns HTTP 401).

Error Messages

errorTextTrigger
"Public alert cannot be owned"The signal is tied to a public admin alert.
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.
adminAlertSignalIdlongRequired

Response

AdminAlertSignalResponse
errorTextstringOptional<=8192 characters

Non-empty if the request failed

adminAlertSignalobjectOptional