Unsubscribe Subscriber
Mark a contact unsubscribed.
MethodPOST
/api/v2/subscribers/:subscriber/unsubscribeMarks a contact unsubscribed. :subscriber is an id or email. Subscriber DELETE is disabled; this is the supported removal path. Permission: subscribers.
Idempotent: repeating the call on an already unsubscribed contact still returns 200.
Path Parameters
| Name | Type | Description |
|---|---|---|
subscriber | string | Required. Subscriber id or email. |
Response Fields
| Field | Type | Description |
|---|---|---|
message | string | Confirmation text. |
id | string | Subscriber id when present. |
email | string | Email when present. |
status | string | UNSUBSCRIBED when present. |
Errors
| Status | name | When |
|---|---|---|
| 401 | missing_api_key | Missing or invalid bearer token |
| 403 | missing_permission | Token lacks the subscribers permission |
| 404 | not_found | Unknown id or email |