Skip to main content

CommunicationPreferenceChannel

Communication preference configuration for a single channel within a category.

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.

CommunicationPreferenceChannel
{
  "channel": "EMAIL",
  "enabled": true,
  "effective": true,
  "editable": true
}