Skip to content

Bulk Add Suppressions

POST
/contacts/suppressions/bulk-add

Suppress an explicit set of contacts in one call. Proxies the SAME handler the app’s Lists -> add-to-suppressions bulk action calls (contacts/router.py:1819), minus the list/filter-model resolution (a UI concept) — pass the contact PKs you already have. Idempotent: already-active rows are left untouched.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
channel
string
default: all
Allowed values: all email phone linkedin
contact_ids
required
Array<integer>
>= 1 items <= 5000 items
reason
Any of:
string
<= 1000 characters

Responses

200

Successful Response

object
data
required
object
channel
required
string
not_found

Requested contact ids that match no contact; nothing was written for them.

Array<integer>
suppressed
required
integer
total_requested
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