Communications Preferences REST Endpoints

Sort by

Task Path Method

V-Model/Communications Preferences

Notification preferences centralize the maintenance of notification 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 Mailing Addresses

Method: get

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

Get Notification Preferences

Method: get

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

Get Notification Preferences By Type

Method: post

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

Get Push Notification Details

Method: get

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

Maintain Notification Preferences By Type

Method: patch

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

Notification Preferences Summary

Method: get

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

Patch Notification 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