Contact Preferences REST Endpoints

Sort by

Task Path Method

Contact Preferences

The Notification Contact resources represent Contact objects related to a Customer and the Contact's notification subscription preferences for Opower communications, such as High Bill Alerts, and channels, such as email and SMS. The API allows you to view and manage Notification Contacts, Notification Preferences, and Notification Events.

Note: To support Telephone Consumer Protection Act (TCPA) compliance and help clients manage their contact preferences (such as opting in or out), the Notification Contact Preferences REST APIs are available to all clients who have purchased the Oracle Utilities Opower outbound products.

Create NotificationContact

Method: post

Path: /apis/notification-contact-v1/{utilityCode}/customers/{id}/notification_contacts

Create NotificationPreference

Method: post

Path: /apis/notification-contact-v1/{utilityCode}/customers/{id}/notification_contacts/{contactId}/notification_preferences

Delete NotificationChannel

Method: delete

Path: /apis/notification-contact-v1/{utilityCode}/customers/{id}/notification_contacts/{contactId}/notification_preferences/channel/{notificationChannel}

Delete NotificationContact

Method: delete

Path: /apis/notification-contact-v1/{utilityCode}/customers/{id}/notification_contacts/{contactId}

Delete NotificationPreference

Method: delete

Path: /apis/notification-contact-v1/{utilityCode}/customers/{id}/notification_contacts/{contactId}/notification_preferences/{preferenceId}

Get Notification Contact List

Method: get

Path: /apis/notification-contact-v1/{utilityCode}/customers/{id}/notification_contacts

Get NotificationPreference

Method: get

Path: /apis/notification-contact-v1/{utilityCode}/customers/{id}/notification_contacts/{contactId}/notification_preferences/{notificationChannel}/{eventType}

Get NotificationPreference List

Method: get

Path: /apis/notification-contact-v1/{utilityCode}/customers/{id}/notification_contacts/{contactId}/notification_preferences

Update NotificationContact

Method: put

Path: /apis/notification-contact-v1/{utilityCode}/customers/{id}/notification_contacts/{contactId}