Skip to content

Suppress Contact

POST
/contacts/{contact_id}/suppress

Stop all outreach to a contact. Proxies the SAME handler the in-app contact view’s “Suppress” action calls (contacts/router.py:1660) — channel=all, category=org_initiated, honoured by every surface that reads the central ledger (sequencer, newsletter, audience_sync).

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

Request Body

object
reason
Any of:
string
<= 1000 characters

Responses

200

Successful Response

object
data
required
object
contact_id
required
integer
is_suppressed
required
boolean
revision
required
integer
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