Skip to content

Check Contact Suppression

GET
/contacts/{contact_id}/suppression

Is this contact suppressed, and on which channel(s)?

Reads the SAME central ledger every send path checks (apps.suppression().service().list_suppressions), so a “not suppressed” answer here means the same thing it means to the sequencer and newsletter send gates.

Authorizations

Parameters

Path Parameters

contact_id
required

Contact ID (mashup_contacts.id)

integer

Contact ID (mashup_contacts.id)

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

Answer to “is this contact suppressed, and on which channels?”.

object
active_channels
Array<string>
contact_id
required
integer
is_suppressed
required
boolean
suppressions
Array<object>

One row of the central contact_suppressions ledger.

object
category
required

Contact_initiated | org_initiated | system

string
channel
required

All | email | phone | linkedin

string
contact_id
required
integer
created_at
Any of:
string
created_by
Any of:
string
id
required
string
reason
Any of:
string
revision
Any of:
integer
source
Any of:
string
source_ref
Any of:
string
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string