Check whether an address is suppressed
Fetch the suppression record for one address. The path parameter is the address itself, URL-encoded.
An address that is NOT suppressed answers 404 resource_not_found — this path addresses the suppression record, and there is none. The answer is definite either way: 200 means suppressed and says why, 404 means not suppressed.
A 200 may also come from a platform-wide block recorded outside this project, in which case the address is genuinely undeliverable for you even though you never suppressed it.
Requires the suppression:read scope — View the 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.
email*stringThe suppressed address, URL-encoded.
emailThe suppression record
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 GET 'https://api.sendly.now/api/v1/suppressions/user@example.com'{ "email": "string", "reason": "HARD_BOUNCE", "source": "string", "created_at": "2019-08-24T14:15:22Z"}