API ReferenceSuppression
Check whether an email is suppressed
GET
Returns { suppressed, reason?, source?, createdAt? }. The path parameter must be URL-encoded.
Requires the suppression:read scope — View the addresses on your suppression list.
header
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.
email*stringURL-encoded email address
Suppression check result
application/json- response
Result of GET /api/suppression/{email} — whether the address is suppressed.
suppressed*booleanreason?stringValue in
"HARD_BOUNCE""COMPLAINT""MANUAL""UNSUBSCRIBE"source?stringValue in
"SES_WEBHOOK""API""DASHBOARD"createdAt?stringISO 8601 datetime string
Format
date-timecurl -X GET 'https://api.sendly.now/api/suppression/string'Example Response
{ "suppressed": true, "reason": "HARD_BOUNCE", "source": "SES_WEBHOOK", "createdAt": "2019-08-24T14:15:22Z"}