Status API › Subscribers
Remove a subscriber
DELETE/api/v1/pages/{pageID}/subscribers/{id}
Removes a subscriber of this page; they get no more mail. A subscriber of another page is not found (404), as is one that does not exist.
Permission (API-key scope): status:subscriber:write.
Authorization
bearerAuth(status:subscriber:write)apiKeyHeader(status:subscriber:write)
Parameters
Path parameters
pageIDstring (uuid) requiredThe status page's id (a UUID).idstring (uuid) requiredThe incident's, maintenance window's or subscriber's id (a UUID).
Responses
204
Removed.
401
No API key was sent, or it is unknown, revoked or expired (UNAUTHORIZED).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThis request's id, also inX-Request-ID.
403
The key lacks the scope this endpoint needs (FORBIDDEN).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThis request's id, also inX-Request-ID.
404
No such item, or one the caller cannot see (NOT_FOUND).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThis request's id, also inX-Request-ID.
429
Too many requests (RATE_LIMITED). Wait Retry-After seconds.
Retry-AfterintegerSeconds to wait.
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThis request's id, also inX-Request-ID.
500
Something went wrong on EvoHub's side (INTERNAL_ERROR). Retry later.
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThis request's id, also inX-Request-ID.
Example request
curl -X DELETE 'https://evohub.io/api/v1/pages/3f6c2a1e-8b4d-4f7a-9c21-5d0e7a9b1c42/subscribers/00000000-0000-0000-0000-000000000000' \
-H 'Authorization: Bearer <TOKEN>'