Suppression

Manually add an email to the suppression list

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.

post/api/suppression

Request

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

Request body

emailstring email required
reason'HARD_BOUNCE' | 'COMPLAINT' | 'MANUAL' | 'UNSUBSCRIBE'

Response

Suppression added

createdAtstring date-time required

ISO 8601 datetime string

emailstring email required
idstring uuid required
projectIdstring uuid required
reason'HARD_BOUNCE' | 'COMPLAINT' | 'MANUAL' | 'UNSUBSCRIBE' required
scope'PROJECT' | 'GLOBAL' required

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

source'SES_WEBHOOK' | 'API' | 'DASHBOARD' required

Changes

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