Skip to content

Update Suppression Settings

PUT
/org/suppression-settings

Set the opt-out scope. Applies to opt-outs from now on; existing ones keep their scope.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
contact_optout_scope
required

channel: an opt-out stays on its channel. all: it covers all outreach.

string
Allowed values: channel all

Responses

200

Successful Response

object
data
required

A settings view or the result of a change, as the app returns it.

object
key
additional properties
any
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