Suppression

Suppress an address

Add an address to this project's suppression list, so no further send reaches it.

Idempotent: suppressing an already-suppressed address answers 201 with the EXISTING record rather than 409. The first reason and source win, because a later manual entry must not overwrite what an SES bounce recorded.

source is NOT accepted in the body — it is derived from the credential (API for an API key, DASHBOARD for a session), so a record's provenance cannot be dressed up as a deliverability fact.

Requires the suppression:write scope — Add and remove addresses on your suppression list.

post/api/v1/suppressions

Request

  • Base URL: https://api.sendly.now
  • URL: https://api.sendly.now/api/v1/suppressions
  • 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

The suppressed address

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.