Skip to content

Set Channel Preference

PUT
/channels/preferences

Set ONE preference. Everything else is left alone.

PUT of a single key/value pair rather than the whole object, matching the app: sending the full set would make a stale read overwrite a change someone else made between your GET and your PUT.

key must be one GET /channels/preferences returned, and value must be a shape that key accepts - anything else is a 422 saying which.

These are org-wide compliance switches. Needs a personal API key whose user can write channel preferences; org admins and owners always can.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Set ONE org-wide channel preference.

object
key
required

Preference key, from GET /channels/preferences

string
value
required

New value. The service rejects a value the key does not accept with a 422.

Responses

200

Successful Response

object
data
required

An open envelope for one provider/deliverability result.

Open on purpose. These payloads are provider state and advisory reads whose contents grow with the product, and a dropped field reads as “nothing to report” rather than “we did not tell you”. Every value passes through scrub_vendor_names on the way in.

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