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

Profile Configuration

Consents

Contact Types

Custom Fields

Groups

Picklists

Preference Configuration

Program Groups

Programs

Filters

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

Integration 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

Events

MyPreferences API

MyPreferences 3.0

MyPreferences 3.0 v4

Production

Sandbox

Add profile

Archive preferences

Commit

Contacts

Create address type

Create alternate Id types

Create consent types

Create customer types

Create datetime custom fields

Create email types

Create group types

Create new subscription

Create numeric custom fields

Create phone types

Create picklists

Create selectlist custom fields

Create text custom fields

Custom Auth Scheme

Delete profile

Delete subscription

Delete tags

Errors

Event Payload Samples

Execute

Historical API's

Initiate

OAuth

PNAUTHINFO3

Preferences

ProfileActions

Rename existing group

Retrieve a program

Retrieve a program by Program Group

Retrieve a program group

Retrieve address types

Retrieve all program groups

Retrieve all programs

Retrieve alternate Id types

Retrieve consent status

Retrieve consent types

Retrieve custom fields

Retrieve customer types

Retrieve data

Retrieve datetime custom fields

Retrieve email types

Retrieve event by event id

Retrieve events

Retrieve events by profile id

Retrieve events by subscription id

Retrieve exceptions

Retrieve Filter

Retrieve group names

Retrieve group profiles by alternate id

Retrieve group profiles by email address

Retrieve group profiles by group name

Retrieve group profiles by phone number

Retrieve group profiles by profile id

Retrieve group types

Retrieve historical consents by alternate id

Retrieve historical consents by profile id

Retrieve historical contact elements by alternate id

Retrieve historical contact elements by profile id

Retrieve historical custom fields by alternate id

Retrieve historical custom fields by profile id

Retrieve historical preferences by alternate id

Retrieve historical preferences by profile id

Retrieve historical standard fields by alternate id

Retrieve historical standard fields by profile id

Retrieve numeric custom fields

Retrieve phone types

Retrieve picklists

Retrieve profile by alternate id

Retrieve profile by profile id

Retrieve profiles by address

Retrieve profiles by consent attributes

Retrieve profiles by custom fields

Retrieve profiles by email

Retrieve profiles by name

Retrieve profiles by partial name

Retrieve profiles by phone

Retrieve profiles by preference attributes

Retrieve profiles by SelectList custom fields

Retrieve profiles by tags

Retrieve program groups (Include All)

Retrieve program groups (Include Matching)

Retrieve programs by Program Type

Retrieve programs (Include All)

Retrieve programs (Include Matching)

Retrieve selectlist custom fields

Retrieve status

Retrieve subscriptions

Retrieve tags

Retrieve text custom fields

Retrieve update rules

Retrieve webhook settings

Stage

Standard Fields

Update address type

Update alternate Id type

Update consent type

Update customer type

Update datetime custom field

Update email type

Update group type

Update numeric custom field

Update phone type

Update picklist

Update profile by alternate id (PATCH))

Update profile by alternate id (POST)

Update profile by alternate id (PUT)

Update profile (PATCH)

Update profile (POST)

Update profile (PUT)

Update selectlist custom field

Update subscription

Update text custom field

Update webhook settings

<p class="slate-p slate-indent-0" style="0px">Getting started with MyPreferences 3.0 <em class="slate-italic">Version 4</em> API is easy.  Before we dive in, let&apos;s spend some time to learn about the supported authorization options and understand how the API library is categorized based on MyPreferences&apos; core framework.</p><h3 class="slate-h3 " >Using API&apos;s</h3><p class="slate-p slate-indent-0" style="0px">Refer to the <strong class="slate-bold">Authorization </strong>section to discover the different authorization methods supported for accessing the MyPreferences API.</p><p class="slate-p slate-indent-0" style="0px">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="0px">In general, the API supports the following request methods:</p><p class="slate-p " ><em class="slate-italic"><strong class="slate-bold">GET</strong></em>: To retrieve a resource</p><p class="slate-p " ><em class="slate-italic"><strong class="slate-bold">POST</strong></em>: To create a new resource</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><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 " ><strong class="slate-bold">Note: </strong>Within the Data API collection, the <code class="slate-code">UpdateProfile</code> 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 " ><em class="slate-italic"><strong class="slate-bold">PUT</strong></em>: To update (overwrite) an existing resource</p><p class="slate-p " ><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="0px"><em class="slate-italic"><strong class="slate-bold">DELETE</strong></em>: To delete a resource</p><p class="slate-p slate-indent-0" style="0px">To access the Swagger specification of the MyPreferences API, click <a href="https://pm.mypreferences.com/profiles/v4/swagger/v1/swagger.json" target="_self">here</a>.</p><h3 class="slate-h3 " >
API Categorization</h3><p class="slate-p " >The API&apos;s are categorized into three separate 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:left"><img src="https://theneo-prod-public.s3.amazonaws.com/images-1698243082479.jpg" style="
              width:719px;
	            height:268px;
	            aspect-ratio:719 / 268"
         /></div><h3 class="slate-h3 " >
Data Categorization</h3><p class="slate-p " >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>. The data elements collected in these areas coalesce to form a unified profile, capturing a comprehensive depiction of an individual&apos;s identity, preferences, and consents across all channels and interactions across their customer journey.</p><h3 class="slate-h3 " >Profiles</h3><p class="slate-p " >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 " >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 " >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 " >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 " ></p><p class="slate-p " ></p>

 API is easy.  Before we dive in, let's spend some time to learn about the supported authorization options and understand how the API library is categorized based on MyPreferences' core framework.

section to discover the different authorization methods supported for accessing 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

To access the Swagger specification of the MyPreferences API, click 

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

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

. The data elements collected in these areas coalesce to form a unified profile, capturing a comprehensive depiction of an individual's identity, preferences, and consents across all channels and interactions across their customer journey.

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.

<p class="slate-p " >The <em class="slate-italic">Experience API&apos;s</em>, 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 " >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 " >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">Preference Configuration</div></li></ul><p class="slate-p " ></p><p class="slate-p " ></p>

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

<p class="slate-p " >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 " >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 " >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><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><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 " >The API responses and sample documents provided in the documentation are for illustrative purposes, helping users understand the API request and response format. Not all data attributes may be included. Developers should refer to the API description and specific callouts for comprehensive details on available properties, limitations, and usage guidelines.</p></div></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></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 " >The <strong class="slate-bold">Integration API </strong>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.</p><h4 class="slate-h4 " >Bulk API</h4><p class="slate-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 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.</p><p class="slate-p " >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 experiences to your customers.</p><h4 class="slate-h4 " >Events API</h4><p class="slate-p " >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.</p><p class="slate-p " ></p><p class="slate-p " ></p>

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.

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

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.

MyPreferences 3.0 v2

Sections