Suppress an address
Add an address to this project's suppression list, so no further send reaches it.
Idempotent: suppressing an already-suppressed address answers 201 with the EXISTING record rather than 409. The first reason and source win, because a later manual entry must not overwrite what an SES bounce recorded.
source is NOT accepted in the body — it is derived from the credential (API for an API key, DASHBOARD for a session), so a record's provenance cannot be dressed up as a deliverability fact.
Requires the suppression:write scope — Add and remove addresses on your suppression list.
AuthorizationBearer <API Key>API key authentication. Use a sk_* (FULL) or pk_* (SENDING_ONLY) key as the bearer token. Public keys (pk_*) are restricted to the email-send endpoints and the self-serve list subscribe/unsubscribe pair; every other endpoint — event tracking included — answers 403 for them. In scope terms (used by /api/v1/* operations): FULL keys hold every scope; SENDING_ONLY keys hold only emails:send.
application/json- body
Body for POST /api/v1/suppressions.
email*stringemailreason?string"MANUAL""HARD_BOUNCE""COMPLAINT""MANUAL""UNSUBSCRIBE"The suppressed address
application/json- response
A suppressed address as exposed on the v1 API.
email*stringreason*string"HARD_BOUNCE""COMPLAINT""MANUAL""UNSUBSCRIBE"source*stringcreated_at*stringdate-timecurl -X POST 'https://api.sendly.now/api/v1/suppressions' \ -H 'Content-Type: application/json' \ -d '{ "email": "user@example.com"}'{ "email": "string", "reason": "HARD_BOUNCE", "source": "string", "created_at": "2019-08-24T14:15:22Z"}