PossibleNOW

# 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.


Overview

Authorization

Experience API

Consents

Contact Types

Custom Fields

Groups

Picklists

Preferences

Data API

A Profile represents a unified view of a user across all channels and touchpoints. A user can be a known or an anonymous individual, an application, or an IoT device. The Profile record can contain demographic and psychographic information, consents, preferences, group associations, feedback and any other pieces of zero-party data collected along the customer journey.


Profile

Bulk API

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.


Export

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.


Import

MyPreferences API

MyPreferences 3.0

MyPreferences 3.0 v2

Production

Sandbox

<p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">Getting started with MyPreferences 3.0 API is easy.  Before we dive in, let&apos;s take a few moments to learn about the authorization schemes and API categorization based on the core framework of MyPreferences. </p><h3 class="slate-h3">Using API&apos;s</h3><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">See the Authorization section to view the authorization schemes required to interact with the MyPreferences API. </p><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">The MyPreferences API is a RESTful API that conforms to the constraints of a
 software architectural style called REST (Representational State Transfer). The API makes the configuration objects and data available as resources represented by unique URLs, also referred as endpoints. </p><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">In general, the API supports the following request methods:</p><p class="slate-p" placeholder="Type / for widgets"><em class="slate-italic"><strong class="slate-bold">GET</strong></em>: To retrieve a resource</p><p class="slate-p" placeholder="Type / for widgets"><em class="slate-italic"><strong class="slate-bold">POST</strong></em>: To create a new resource</p><div  data-type="info" style="background-color:#eef1ff;color:#4a59af"><div ><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Note: </strong>Within the Data API collection, the <strong class="slate-bold">Update Profile</strong> method is accessible through a POST request to efficiently update a profile. This purpose-built design empowers client-facing apps to modify profiles directly, eliminating the need to retrieve them beforehand.</p></div></div><p class="slate-p" placeholder="Type / for widgets"><em class="slate-italic"><strong class="slate-bold">PUT</strong></em>: To update (overwrite) an existing resource</p><p class="slate-p" placeholder="Type / for widgets"><em class="slate-italic"><strong class="slate-bold">PATCH:</strong></em> To perform partial updates to an existing resource</p><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets"><em class="slate-italic"><strong class="slate-bold">DELETE</strong></em>: To delete a resource
</p><h3 class="slate-h3">
API Categorization</h3><p class="slate-p" placeholder="Type / for widgets">The API&apos;s are categorized into three sets with distinct functionalities based on the application&apos;s core framework: <strong class="slate-bold">Experiences</strong>, <strong class="slate-bold">Data</strong>, and <strong class="slate-bold">Connectivity.</strong></p><div style="text-align:undefined"><img src="https://theneo-prod-public.s3.amazonaws.com/images-1688153188866.PNG" alt=""/></div><h3 class="slate-h3">
Data Categorization</h3><p class="slate-p" placeholder="Type / for widgets">In MyPreferences, the data is organized in three main areas: <strong class="slate-bold">Profiles</strong>, <strong class="slate-bold">Preferences </strong>and <strong class="slate-bold">Consents</strong>.</p><h3 class="slate-h3">Profiles</h3><p class="slate-p" placeholder="Type / for widgets">In the <strong class="slate-bold">Profiles </strong>area, you can store various data points including names, contact information, group affiliations, and a wide range of demographic and psychographic details. </p><p class="slate-p" placeholder="Type / for widgets">Additionally, you have the flexibility to store multiple <em class="slate-italic">Alternate IDs</em>, such as system and device identifiers, to uniquely identify individuals and devices within your enterprise ecosystem. This area also encompasses the storage of consents not linked to specific contact elements or preferences, along with <em class="slate-italic">Tags</em>, <em class="slate-italic">Custom Fields</em>, and <em class="slate-italic">Groups </em>for comprehensive organization and categorization of customer data.</p><h3 class="slate-h3">Preferences</h3><p class="slate-p" placeholder="Type / for widgets">The <strong class="slate-bold">Preferences </strong>area stores all customer choices, subscriptions, communication frequencies, engagement channels, and any preference attributes. Designed with 
built-in rules to honor the right preference, propagate preferences, apply expiration, associate consents, and maintain complete preference history to satisfy compliance audits.</p><h3 class="slate-h3">Consents</h3><p class="slate-p" placeholder="Type / for widgets">The <strong class="slate-bold">Consents </strong>area serves as a universal consent repository that stores and manages all 
customer consents. With limitless granularity, you can attach consents to an individual, device or an application. You can also associate consents to a contact element or a preference communication. Designed with built-in rules to honor the right consent, apply expiration settings, auto-notify when a new consent version becomes available, and maintain complete consent history to satisfy compliance audits.</p><p class="slate-p" placeholder="Type / for widgets"></p>

Getting started with MyPreferences 3.0 API is easy.  Before we dive in, let's take a few moments to learn about the authorization schemes and API categorization based on the core framework of MyPreferences. 

See the Authorization section to view the authorization schemes required to interact with the MyPreferences API. 

The MyPreferences API is a RESTful API that conforms to the constraints of a
 software architectural style called REST (Representational State Transfer). The API makes the configuration objects and data available as resources represented by unique URLs, also referred as endpoints. 

In general, the API supports the following request methods:

: To update (overwrite) an existing resource

 To perform partial updates to an existing resource

The API's are categorized into three sets with distinct functionalities based on the application's core framework: 

In MyPreferences, the data is organized in three main areas: 

area, you can store various data points including names, contact information, group affiliations, and a wide range of demographic and psychographic details. 

Additionally, you have the flexibility to store multiple 

, such as system and device identifiers, to uniquely identify individuals and devices within your enterprise ecosystem. This area also encompasses the storage of consents not linked to specific contact elements or preferences, along with 

for comprehensive organization and categorization of customer data.

area stores all customer choices, subscriptions, communication frequencies, engagement channels, and any preference attributes. Designed with 
built-in rules to honor the right preference, propagate preferences, apply expiration, associate consents, and maintain complete preference history to satisfy compliance audits.

area serves as a universal consent repository that stores and manages all 
customer consents. With limitless granularity, you can attach consents to an individual, device or an application. You can also associate consents to a contact element or a preference communication. Designed with built-in rules to honor the right consent, apply expiration settings, auto-notify when a new consent version becomes available, and maintain complete consent history to satisfy compliance audits.

<h3 class="slate-h3">Authorization Header</h3><p class="slate-p" placeholder="Type / for widgets">To access MyPreferences Web Services, it is necessary to include an authorization field in the HTTP Header for all types of requests. This authorization field should contain the appropriate Authorization Scheme and relevant parameters, adhering to the format specified by RFC 7235. The scheme and parameters within the Authorization Header should be separated by a space, as per the defined guidelines.</p><div style="text-align:center"><img src="https://theneo-prod.s3.amazonaws.com/images-1671805642003.PNG" alt="" width="291" id="1688154613794"/></div><h3 class="slate-h3">Authorization Schemes</h3><p class="slate-p" placeholder="Type / for widgets">Currently there are two scheme types and one available scheme identifier for authorization. Additional schemes may be added to address any weaknesses in the authorization header by adding or removing additional parameters. The authorization scheme types allow for a keyed hash and un-keyed hash.</p><p class="slate-p" placeholder="Type / for widgets">It is highly recommended that the keyed hash scheme be used whenever possible as it is more secure. Please note that the authorization scheme
 is case <strong class="slate-bold">in</strong>sensitive. An example of each of the two scheme types is shown below:</p><table class="slate-table"><colgroup></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr"><th class="slate-th"><p class="slate-p" placeholder="Type / for widgets">Un-keyed Hash Scheme</p></th><th class="slate-th"><p class="slate-p" placeholder="Type / for widgets">Keyed Hash Scheme</p></th></tr><tr class="slate-tr"><td class="slate-td"><div class="slate-TableCellElement-content"><p class="slate-p" placeholder="Type / for widgets">SchemeIdentifier-CryptoHashIdentifier</p></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content"><p class="slate-p" placeholder="Type / for widgets">SchemeIdentifier-HMAC-CryptoHashIdentifier</p></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td></tr></tbody></table><table class="slate-table"><colgroup></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr"><th class="slate-th"><p class="slate-p" placeholder="Type / for widgets">Un-keyed Hash Scheme</p></th><th class="slate-th"><p class="slate-p" placeholder="Type / for widgets">Keyed Hash Scheme</p></th></tr><tr class="slate-tr"><td class="slate-td"><div class="slate-TableCellElement-content"><p class="slate-p" placeholder="Type / for widgets">PNAUTHINFO3-SHA256</p></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content"><p class="slate-p" placeholder="Type / for widgets">PNAUTHINFO3-HMAC-SHA256</p></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td></tr></tbody></table><p class="slate-p" placeholder="Type / for widgets">The <em class="slate-italic">SchemeIdentifier</em> drives and defines the authorization process and parameters. Each available scheme identifier will be addressed in the following sections.</p><p class="slate-p" placeholder="Type / for widgets">The <em class="slate-italic">CryptoHashIdentifier</em> is the name of the hash algorithm that is used to generate the signature parameter in all of the scheme authorization parameters. The following hash functions from the SHA-2 family are currently available:</p><ul class="slate-ul"><li class="slate-li"><div style="position:relative">SHA256</div></li><li class="slate-li"><div style="position:relative">SHA384</div></li><li class="slate-li"><div style="position:relative">SHA512</div></li></ul><h3 class="slate-h3">Available Schemes</h3><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><a href="https://docs.mypreferences.com/mypreferences3/overview/authorization/pnauthinfo3" target="_self">PNAUTHINFO3</a></div></li></ul><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets">

</p><p class="slate-p" placeholder="Type / for widgets"></p>

To access MyPreferences Web Services, it is necessary to include an authorization field in the HTTP Header for all types of requests. This authorization field should contain the appropriate Authorization Scheme and relevant parameters, adhering to the format specified by RFC 7235. The scheme and parameters within the Authorization Header should be separated by a space, as per the defined guidelines.

Currently there are two scheme types and one available scheme identifier for authorization. Additional schemes may be added to address any weaknesses in the authorization header by adding or removing additional parameters. The authorization scheme types allow for a keyed hash and un-keyed hash.

It is highly recommended that the keyed hash scheme be used whenever possible as it is more secure. Please note that the authorization scheme
 is case 

sensitive. An example of each of the two scheme types is shown below:

 drives and defines the authorization process and parameters. Each available scheme identifier will be addressed in the following sections.

 is the name of the hash algorithm that is used to generate the signature parameter in all of the scheme authorization parameters. The following hash functions from the SHA-2 family are currently available:

<p class="slate-p" placeholder="Type / for widgets">The Experience API&apos;s, also known as Configuration API&apos;s, are a suite of API&apos;s purpose-built for retrieving zero-party data configurations to drive highly personalized and relevant customer experiences.</p><p class="slate-p" placeholder="Type / for widgets">These APIs have built-in localization support and offer specific query parameters to retrieve customized consent, preference, and other zero-party data configurations. This grants you total control over your customers&apos; experiences, covering everything from micro experiences to comprehensive preference centers and everything in between.</p><p class="slate-p" placeholder="Type / for widgets">These API&apos;s are classified as follows:</p><ul class="slate-ul"><li class="slate-li"><div style="position:relative">Profile Configuration</div></li><li class="slate-li"><div style="position:relative"><a href="https://pmstg.mypreferences.com/API/3/Help/Categorical" target="_self">Preference Configuration</a></div></li></ul><p class="slate-p" placeholder="Type / for widgets"></p><div  data-type="info" style="background-color:#eef1ff;color:#4a59af"><div ><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p" placeholder="Type / for widgets">Both MyPreferences 2.0 customers and MyPreferences 3.0 customers utilizing the Version 2 API&apos;s utilize the Preference Configuration <a href="https://pm.mypreferences.com/API/3/Help/Categorical" target="_self">APIs</a>. Therefore, MyPreferences 3.0 users who rely on the Version 2 API&apos;s should take note of the different routes when working with these API&apos;s. </p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets">It is important to note that none of the other APIs are relevant or applicable to MyPreferences 3.0 customers.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets">We highly recommend MyPreferences 3.0 users using the Version 2 API&apos;s to switch to Version 4 which offers a central Base URL. To switch to Version 4 API&apos;s, simply update the version number from “v2” to “v4” in your Base URL as shown below:</p><p class="slate-p slate-indent-1" style="margin-left:24px" placeholder="Type / for widgets"></p><p class="slate-p slate-indent-1" style="margin-left:24px" placeholder="Type / for widgets">Version 2:  https://pm.mypreferences.com/Profiles/v2</p><p class="slate-p slate-indent-01" style="margin-left:24px" placeholder="Type / for widgets"><strong class="slate-bold">Version 4:</strong> https://pm.mypreferences.com/Profiles/<strong class="slate-bold">v4</strong></p><p class="slate-p slate-indent-01" style="margin-left:24px" placeholder="Type / for widgets"><strong class="slate-bold"></strong></p><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">Update all references that are using the Preference Configuration API as follows:</p><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets"></p><p class="slate-p slate-indent-01" style="margin-left:24px" placeholder="Type / for widgets"><strong class="slate-bold">From</strong>: https://pm.mypreferences.com/API/3 </p><p class="slate-p slate-indent-01" style="margin-left:24px" placeholder="Type / for widgets"><strong class="slate-bold">To</strong>: https://pm.mypreferences.com/Profiles/v4</p><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets"></p></div></div><h3 class="slate-h3">Profile Configuration </h3><p class="slate-p" placeholder="Type / for widgets">The Profile Configuration API allows you to define all aspects of customer profile configuration including names, contact information, group affiliations, and a wide range of demographic and psychographic details using standard and custom fields.</p><p class="slate-p" placeholder="Type / for widgets">Additionally, you have the flexibility to create <em class="slate-italic">Alternate IDs</em>, such as system and device identifiers, to uniquely identify individuals and devices within your enterprise ecosystem. This API also allows you to create and manage <em class="slate-italic">Consents</em>, <em class="slate-italic">Tags</em>, <em class="slate-italic">Custom Fields</em>, and <em class="slate-italic">Groups </em>for comprehensive organization and categorization of customer data.</p><h3 class="slate-h3">Preference Configuration </h3><p class="slate-p" placeholder="Type / for widgets">The Preference Configuration API allows you to define and manage all aspects of preference configuration which includes the creation of <em class="slate-italic">Programs</em>, <em class="slate-italic">Filters</em>, <em class="slate-italic">Program Groups</em>, <em class="slate-italic">Frequency Options</em>, <em class="slate-italic">Preference Attributes</em>, <em class="slate-italic">Custom Properties</em>, and <em class="slate-italic">Locales</em>. </p><p class="slate-p" placeholder="Type / for widgets"><a href="https://pm.mypreferences.com/API/3/Help/Categorical" target="_self">Preference Configuration APIs</a></p>

The Experience API's, also known 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 APIs have built-in localization support and offer specific query parameters to retrieve customized consent, preference, and other zero-party data configurations. This grants you total control over your customers' experiences, covering everything from micro experiences to comprehensive preference centers and everything in between.

The Profile Configuration API allows you to define all aspects of customer profile configuration including names, contact information, group affiliations, and a wide range of demographic and psychographic details using standard and custom fields.

Additionally, you have the flexibility to create 

, such as system and device identifiers, to uniquely identify individuals and devices within your enterprise ecosystem. This API also allows you to create and manage 

The Preference Configuration API allows you to define and manage all aspects of preference configuration which includes the creation of 

<p class="slate-p" placeholder="Type / for widgets">The Data API&apos;s facilitate the display and collection of zero-party data for individual profiles across customer touchpoints. When driving customer experiences, they work seamlessly in conjunction with the Experience API to ensure that the relevant elements are accurately displayed on user interfaces, delivering highly personalized customer experiences.</p><p class="slate-p" placeholder="Type / for widgets">Using the Data API&apos;s, you can use any data point on a profile to retrieve the profile. Please note that using <em class="slate-italic">contact elements</em>, <em class="slate-italic">custom fields</em>, <em class="slate-italic">groups</em>, and <em class="slate-italic">tags </em>to retrieve a profile may result in multiple matching profiles being returned.</p><p class="slate-p" placeholder="Type / for widgets">A suite of historical API&apos;s are also available as part of this API library. You can retrieve the entire history for any data point associated with a user&apos;s profile, including standard fields, contact elements, custom fields, preferences, consents, and more.</p><p class="slate-p" placeholder="Type / for widgets"></p>

The Data API's facilitate the display and collection of zero-party data for individual profiles across customer touchpoints. When driving customer experiences, they work seamlessly in conjunction with the Experience API to ensure that the relevant elements are accurately displayed on user interfaces, delivering highly personalized customer experiences.

Using the Data API's, you can use any data point on a profile to retrieve the profile. Please note that using 

to retrieve a profile may result in multiple matching profiles being returned.

A suite of historical API's are also available as part of this API library. You can retrieve the entire history for any data point associated with a user's profile, including standard fields, contact elements, custom fields, preferences, consents, and more.

<p class="slate-p" placeholder="Type / for widgets">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. It ensures that you can effortlessly manage and exchange large datasets, streamlining the process of integrating zero-party data across your technology ecosystem.</p><p class="slate-p" placeholder="Type / for widgets">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 personalized and tailored experiences to your customers.</p><p class="slate-p" placeholder="Type / for widgets"></p>

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. 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 personalized and tailored experiences to your customers.

Sections