Skip to main content

Get Customer Communication Preferences

GET 
/v2/customer-persons/:customerId/communications/preferences

Returns the communication preferences for the specified customer, organized by category and channel.

Categories may be nested using the parent property. Categories are returned already sorted for display, and a parent category always appears before its children. When the categories filter is used, a matched child category may be returned without its parent, so the category a parent points to may be missing from the list.

If no categories match the filter, an empty array is returned. If the parameter is omitted, the full list is returned.

Each channel exposes the customer's enabled setting, the effective state after applying inherited (parent) settings and system constraints, and whether the setting is editable.

Request​

Responses​

OK