Suppression

Check whether an email is suppressed

Returns { suppressed, reason?, source?, createdAt? }. The path parameter must be URL-encoded.

Requires the suppression:read scope — View the addresses on your suppression list.

get/api/suppression/{email}

Request

  • Base URL: https://api.sendly.now
  • URL: https://api.sendly.now/api/suppression/{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 required

URL-encoded email address

Response

Suppression check result

createdAtstring date-time

ISO 8601 datetime string

reason'HARD_BOUNCE' | 'COMPLAINT' | 'MANUAL' | 'UNSUBSCRIBE'
source'SES_WEBHOOK' | 'API' | 'DASHBOARD'
suppressedboolean required

Changes

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