Skip to Content
SendlySendly
API ReferenceSuppression

Manually add an email to the suppression list

POST
/api/suppression

The source field is auto-derived: API for API-key callers, DASHBOARD for session callers.

Requires the suppression:write scope — Add and remove addresses on your suppression list.

headerAuthorizationBearer <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
  1. body

Body for POST /api/suppression — manually add an email to the suppression list.

email*string
Formatemail
reason?string
Default"MANUAL"
Value in"HARD_BOUNCE""COMPLAINT""MANUAL""UNSUBSCRIBE"

Response Body

Suppression added

application/json
  1. response

A single suppressed-email record.

id*string
Formatuuid
projectId*string
Formatuuid
email*string
Formatemail
reason*string
Value in"HARD_BOUNCE""COMPLAINT""MANUAL""UNSUBSCRIBE"
source*string
Value in"SES_WEBHOOK""API""DASHBOARD"
scope*string

How far the suppression reaches. PROJECT is every record this API creates or returns today.

Value in"PROJECT""GLOBAL"
createdAt*string

ISO 8601 datetime string

Formatdate-time
Example Request
curl -X POST 'https://api.sendly.now/api/suppression' \  -H 'Content-Type: application/json' \  -d '{  "email": "user@example.com"}'
Example Response
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",  "email": "user@example.com",  "reason": "HARD_BOUNCE",  "source": "SES_WEBHOOK",  "scope": "PROJECT",  "createdAt": "2019-08-24T14:15:22Z"}