Complete Alert Signal
Mark an admin alert signal as complete.
Available to: Traders (public admin alert signals they can read)
Environments: Demo, Live
Rate Limit: No endpoint-specific limit
Mark the admin alert signal identified by adminAlertSignalId as complete. On success, the response returns the updated adminAlertSignal with its completed time set.
You can complete signals for public admin alerts only. A signal for any other admin alert isn’t visible to you, so it returns HTTP 404.
Common Failure Scenarios
- The signal is already complete. This returns
HTTP 200with"Already completed"inerrorText, along with the signal unchanged. - No signal matches
adminAlertSignalId, or the signal isn’t visible to you. Both returnHTTP 404with an empty body. A signal is visible only if its admin alert is public, the signal hasn’t expired, and it’s addressed to you, to an account you can read, or to everyone. adminAlertSignalIdisn’t greater than 0. This returnsHTTP 400.- 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".
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
Related Endpoints
- Use
adminAlertSignalListto find signals and their IDs.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
Response
Non-empty if the request failed