Overview
Configuration
The Experience API's, also referred to as Configuration API's, are a suite of API's purpose-built for retrieving zero-party data configurations to drive highly personalized and relevant customer experiences.
These API's natively support localization and specific query parameters to return custom configurations, consents, preference choices, and other data elements, giving you complete control over your customers' experiences, spanning from micro experiences to full-featured preference centers and everything in between.
These API's are classified as follows:
- Profile Configuration
- Preference Configuration
NOTE
Both MyPreferences 2.0 and 3.0 customers utilize the Configuration APIs. However, users of MyPreferences 3.0 must be cognizant about the route discrepancy when using these APIs. The Configuration API along with the Synchronization API are the only API's relevant to MyPreferences 3.0 users, and they can be accessed here.
On this page
- Overview
Experience API
On this page
- Experience API
Data API
On this page
- Data API
Integration API
The Integration API suite includes asynchronous RESTful APIs for bulk import/export operations and Event APIs for retrieving event data, along with webhook subscriptions for real-time updates.
Bulk API
The MyPreferences 3.0 Bulk API is a powerful and efficient asynchronous RESTful API that serves as a robust conduit for seamless data transfer between MyPreferences and various external systems within your enterprise. It ensures that you can effortlessly manage and exchange large datasets, streamlining the process of integrating zero-party data across your technology ecosystem.
One of the primary advantages of the Bulk API lies in its ability to enable near-real time synchronization of customer data. This means that any updates or changes made within MyPreferences or other connected cloud-based or on-premise systems in your enterprise are swiftly propagated and reflected in the interconnected systems. As a result, your organization can maintain a consistent, up-to-date, and comprehensive view of customer data, which is essential for delivering relevant and compliant experiences.
Events API
Event APIs allow you to retrieve event data by account, subscription, profile, or specific event ID based on your webhook subscriptions. They facilitate experiences which enable customers to view their activity history, recent actions, and profile updates in real-time. By retrieving data based on webhook subscriptions, these APIs allow customers to track and review any changes or interactions they have made to their profiles, ensuring they have access to the most up-to-date information about their account activities.
What made this section unhelpful for you?
Base URL
Production:
Sandbox:
What made this section unhelpful for you?
Export
The Bulk Export API allows you to retrieve data defined in your data segments to establish near real-time integrations between MyPreferences and other systems, support audience-building use cases, or build an internal service that receives updates at specific intervals.
In addition to retrieving data from segments in full, incremental access is also available by including “lastdatetime” when initiating the request.
What made this section unhelpful for you?
On this page
- Export
Segments
On this page
- Segments
Segment Groups
What made this section unhelpful for you?
On this page
- Segment Groups
Initiate
What made this section unhelpful for you?
On this page
- Initiate
Retrieve status
What made this section unhelpful for you?
On this page
- Retrieve status
Retrieve data
What made this section unhelpful for you?
On this page
- Retrieve data
Commit
What made this section unhelpful for you?
On this page
- Commit
Import
The MyPreferences Import Bulk API allows you to import large sets of zero-party data, including customer profile data, preferences and consents within MyPreferences. It enables you to establish periodical imports to sync MyPreferences with customer data captured in other applications.
Workflow:
Initiate: Request to initiate an import
Stage: Stage data that you want to import using the access token. Depending on the size of your request, you may make multiple requests to stage your entire dataset to import
Execute: Once all the data is staged, request to execute the import
Status: Check the status of your import by polling the Status endpoint using the status token
Retrieve (optional): Retrieve any validation failures and exceptions using the Exceptions endpoint.
On this page
- Import
Events
On this page
- Events
User Management
On this page
- User Management