Suppress a recipient
POST/v1/suppressions
Adds a recipient this account will not send to. Only unsubscribe and manual may be set by hand — bounces and complaints are recorded by the platform, and letting a customer assert one would corrupt the deliverability signals routing depends on.
Body
| Field | Type | Description |
|---|---|---|
| recipientrequired | string | |
| reason | string | One of unsubscribe, manual. |
Example
curl -X POST https://api.woyra.io/v1/suppressions \
-H "Authorization: Bearer $WOYRA_KEY" \
-H 'Content-Type: application/json' \
-d '{
"recipient": "<recipient>"
}'Response
201 The suppression.
| Field | Type | Description |
|---|---|---|
| object | "suppression" | |
| recipient | string | |
| reason | string | One of hard_bounce, complaint, unsubscribe, manual. |
| created_at | timestamp |
Errors
| Status | Codes |
|---|---|
| 400 | invalid_request, unsupported_version |
Also in Suppressions
- GET /v1/suppressions — List suppressed recipients
- DELETE /v1/suppressions/{recipient} — Unsuppress a recipient