Communications Preferences REST Endpoints

Sort by

Task Path Method

V-Model/Communications Preferences

Communication preferences centralize the maintenance of communication preferences and notification types that are allowed for an account. Opt-out and opt-in for push notifications are for the entire account, therefore it is generally recommended to only allow updates for the person that is the main customer for the account.

Get Communication Preferences

Method: get

Path: /rest/apis/customer/v-model/communicationsPreferences/{accountId}/{personId}

Get Mailing Addresses

Method: get

Path: /rest/apis/customer/v-model/communicationsPreferences/{accountId}/{personId}/addresses

Get Push Notification Details

Method: get

Path: /rest/apis/customer/v-model/communicationsPreferences/{accountId}/{notificationType}/getNotificationDetails

Patch Communication Preferences

Method: patch

Path: /rest/apis/customer/v-model/communicationsPreferences/{accountId}/{personId}

Update Mailing Address

Method: patch

Path: /rest/apis/customer/v-model/communicationsPreferences/{accountId}/{personId}/addresses