Skip to main content
POST
Suppress an Identifier

Authorizations

Authorization
string
header
required

Bearer token authentication using your API key

Path Parameters

org_id
string
required

The ID of the org

Body

Schema for suppressing a single identifier

channel
enum<string>
required

The channel an identifier is suppressed on

Available options:
EMAIL,
PHONE
identifier
string
required

The email or phone number to suppress

Maximum string length: 320
reason
enum<string>

Defaults to MANUAL

Available options:
BOUNCE,
COMPLAINT,
UNSUBSCRIBE,
MANUAL,
LEGAL
note
string | null
Maximum string length: 500

Response

200 - application/json

Schema for the suppression

id
string
required
channel
enum<string>
required

The channel an identifier is suppressed on

Available options:
EMAIL,
PHONE
identifier
string
required
reason
enum<string>
required

Why the identifier is suppressed

Available options:
BOUNCE,
COMPLAINT,
UNSUBSCRIBE,
MANUAL,
LEGAL
source
enum<string>
required

What put the identifier on the list

Available options:
WEBHOOK,
UNSUBSCRIBE_LINK,
ADMIN,
IMPORT,
API
note
string | null
required
metadata
object | null
required

Diagnostic context kept alongside a suppression

created_by
object
required

Who added the entry. Null when it landed automatically (bounce, complaint, unsubscribe link).

created_at
string<date-time>
required
updated_at
string<date-time>
required