Skip to main content
POST
Suppress one address

Authorizations

Authorization
string
header
required

Tenant API key (vdx_live_…) as Authorization: Bearer.

Body

application/json
value
string
required
kind
enum<string>
Available options:
phone,
email
reason
string
source
enum<string>

Where a suppression came from. account entries are the ones a person-level flag created, and the only ones clearing that flag removes.

Available options:
account,
upload,
api

Response

Suppressed.

id
string<uuid>
kind
enum<string>
Available options:
phone,
email
value
string

Normalised by the same code the channel path uses.

reason
string | null
source
enum<string>

Where a suppression came from. account entries are the ones a person-level flag created, and the only ones clearing that flag removes.

Available options:
account,
upload,
api
accountId
string<uuid> | null

Set when a person-level flag created this entry.

createdAt
string<date-time>