Skip to main content
POST
Suppress a contact

Authorizations

Authorization
string
header
required

Your API key, e.g. sk_live_... or sk_test_....

Headers

Idempotency-Key
string

Optional. Makes this write safe to retry: the same key replays the first response instead of acting twice.

Maximum string length: 255

Path Parameters

contact
string
required

Contact uuid.

Body

application/json
scope
string

What they opted out of. Defaults to marketing.

reason
string

Free text. Defaults to api_suppression.

Response

Suppressed.

suppressed
boolean
scope
string