Skip to main content
POST
Add a suppression

Authorizations

Authorization
string
header
required

An API key from the dashboard. sk_live_… sends; sk_test_… validates and returns ids without sending.

Body

application/json
email
string<email>
required
reason
enum<string>
default:manual

manual blocks all email; unsubscribe blocks marketing only.

Available options:
manual,
unsubscribe
note
string
Maximum string length: 500

Response

Already listed

id
string
required
Example:

"sup_01j9x7k2r4m8q3v5n6b7c8d9e0"

email
string
required
reason
enum<string>
required
Available options:
hard_bounce,
complaint,
unsubscribe,
manual
messageId
string | null
required

The message whose bounce

note
string | null
required
createdAt
string<date-time>
required