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.

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.

Initiate request by specifying a segment name. Specify lastdatetime to retrieve updates for a specific period.

You can also specify MatchCriteria to retrieve data for specific profiles. ProfileID, AlternateID, EmailAddress, and PhoneNumber are the supported match criteria. Based on your match criteria, specify one or more corresponding values under the Values array.

You can optionally specify a Customer Type when using ProfileID as the match criteria. The output data will be generated based on the defined segment criteria and will only include profiles from your request that contain the specified customer type.

When using EmailAddress or PhoneNumber as the match criteria, you should only indicate a Type if the segment does not have any Types configured. If the segment already includes search criteria that filters based on Types, providing a Type will result in the API responding with a 409-Conflict response code.

Returns the status of your request. If a callback URL is provided with your request, MyPreferences will POST the status to the callback URL.

Retrieve the data. You may iterate through multiple calls until all records are retrieved. The access token will expire automatically upon complete data retrieval.

Set the keepAlive parameter to true to retrieve data beyond the initial retrieval. The default value is set to false, if not specified.

This endpoint should only be accessed if the keepAlive parameter was set to true when retrieving the data. Invoking this endpoint marks the data retrieval as “complete” and expires the access token.

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.