Channels

Set Channel Preference

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.

put/channels/preferences

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/channels/preferences
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

keystring required

Preference key, from GET /channels/preferences

valueunknown required

Response

Successful Response

dataMailboxDomainPayload 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.

Changes

No recorded changes to this operation across all 2 revisions of this API.