CommunicationPreferences

Communication preferences for the customer, grouped by category and channel.

categories object[]required

Categories returned for the customer. Returned already sorted for display, and a parent category always appears before its children.

Array [

codestringrequired

Code identifying the category.

Possible values: <= 64 characters

Example: PAYMENTS

parentstring

Code of the parent category. Omitted for top-level categories, and the hierarchy is limited to one level of nesting. When the categories filter is omitted this always references the code of another category in the same response; when the filter is used a matched child may be returned without its parent, so the referenced category can be absent.

Possible values: <= 64 characters

Example: PAYMENTS

channels object[]required

Channel settings for the category. Each channel appears at most once.

Array [

channelCommunicationChannel (string)required

Channel used to deliver communications.

• EMAIL - Delivered to the customer's registered email address.
• SMS - Delivered as a text message to the customer's registered mobile number.
• PUSH_NOTIFICATION - Delivered as a push notification to the customer's registered devices.

Possible values: [EMAIL, SMS, PUSH_NOTIFICATION]

Example: EMAIL

enabledbooleanrequired

Whether the customer has enabled this channel for the category, after applying configured, customer chosen and default settings. Falls back to the configured default when the customer has never changed the preference.

effectivebooleanrequired

Effective state after applying inherited (parent) settings and system constraints.

editablebooleanrequired

Whether the customer is allowed to change this setting.

]

]

CommunicationPreferences

{
  "categories": [
    {
      "code": "PAYMENTS",
      "parent": "PAYMENTS",
      "channels": [
        {
          "channel": "EMAIL",
          "enabled": true,
          "effective": true,
          "editable": true
        }
      ]
    }
  ]
}