Skip to main content
POST
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Headers

Idempotency-Key
string

Makes this write safe to retry: a repeat with the same key replays the first response instead of creating a second resource. Scoped to the account, remembered for 24 hours; reusing a key with a different payload is an error.

Maximum string length: 255

Body

application/json
address
string
required
reason
enum<string>

Why the address is suppressed. Defaults to manual. Bounces and complaints are recorded automatically from delivery events and cannot be set here.

Available options:
manual,
unsubscribed
metadata
object

Response

Address suppressed

object
string
required
id
string
required
address
string
required
reason
enum<string>
required
Available options:
bounced,
complained,
unsubscribed,
manual
email_message
string | null
required
metadata
object
required
created_at
string<date-time>
required