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
addresses
string[]
required
Maximum array length: 100
reason
enum<string>
Available options:
manual,
unsubscribed
metadata
object

Response

Addresses suppressed

object
enum<string>
required
Available options:
list
data
object[]
required
has_more
boolean
required
url
string
required