Skip to main content
GET
Send check

Authorizations

x-api-key
string
header
required

A workspace API key (Settings → API keys), scoped to <group>:read / <group>:write.

Path Parameters

id
string
required

Query Parameters

channel
string
required
purpose
string | null

Response

Success

contactId
string
required
channel
enum<string>
required
Available options:
email,
sms,
whatsapp,
phone,
post
purpose
enum<string>
required
Available options:
service,
marketing
allowed
boolean
required
reason
enum<string> | null
required
Available options:
do_not_contact,
channel_refused,
marketing_consent_missing,
no_address,
contact_retired,
contact_archived,
texted_stop
message
string | null
required
allowedChannels
enum<string>[]
required
Available options:
email,
sms,
whatsapp,
phone,
post