Channels

Get Channel Preferences

Every org-wide channel preference, with defaults already applied.

A key that is missing from the org's stored settings still appears here carrying its default, so this is the complete list of what PUT /channels/preferences will accept - there is no separate schema endpoint to look one up in.

Needs a personal API key whose user can read channel preferences.

get/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

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.