Suppression

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.

get/api/v1/suppressions/{email}

Request

  • Base URL: https://api.sendly.now
  • URL: https://api.sendly.now/api/v1/suppressions/{email}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie better-auth.session_token
    • OAuth 2 (authorization code, authorization URL https://app.sendly.now/api/auth/oauth2/authorize, token URL https://app.sendly.now/api/auth/oauth2/token, scopes: suppression:read)

Path parameters

emailstring email required

The suppressed address, URL-encoded.

Response

The suppression record

created_atstring date-time required
emailstring required
reason'HARD_BOUNCE' | 'COMPLAINT' | 'MANUAL' | 'UNSUBSCRIBE' required
sourcestring required

Changes

No recorded changes to this operation across all 1 revision of this API.