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

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. <h3 class="slate-h3">Using API&apos;s</h3>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:GET: To retrieve a resourcePOST: To create a new resource<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 >Note: Within the Data API collection, the Update Profile 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.</div></div>PUT: To update (overwrite) an existing resourcePATCH: To perform partial updates to an existing resourceDELETE: To delete a resource
<h3 class="slate-h3">
API Categorization</h3>The API&apos;s are categorized into three sets with distinct functionalities based on the application&apos;s core framework: Experiences, Data, and Connectivity.<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>In MyPreferences, the data is organized in three main areas: Profiles, Preferences and Consents.<h3 class="slate-h3">Profiles</h3>In the Profiles 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 Alternate IDs, 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 Tags, Custom Fields, and Groups for comprehensive organization and categorization of customer data.<h3 class="slate-h3">Preferences</h3>The Preferences 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.<h3 class="slate-h3">Consents</h3>The Consents 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.

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.

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.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.These API&apos;s are classified as follows:<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><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 >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. It is important to note that none of the other APIs are relevant or applicable to MyPreferences 3.0 customers.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:Version 2: https://pm.mypreferences.com/Profiles/v2Version 4: https://pm.mypreferences.com/Profiles/v4Update all references that are using the Preference Configuration API as follows:From: https://pm.mypreferences.com/API/3 To: https://pm.mypreferences.com/Profiles/v4</div></div><h3 class="slate-h3">Profile Configuration </h3>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 Alternate IDs, 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 Consents, Tags, Custom Fields, and Groups for comprehensive organization and categorization of customer data.<h3 class="slate-h3">Preference Configuration </h3>The Preference Configuration API allows you to define and manage all aspects of preference configuration which includes the creation of Programs, Filters, Program Groups, Frequency Options, Preference Attributes, Custom Properties, and Locales. <a href="https://pm.mypreferences.com/API/3/Help/Categorical" target="_self">Preference Configuration APIs</a>

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 

MyPreferences serves as a universal consent repository managing consents around an individual or device (IoT) across any data category. The Consents API suite allows you to create, update, and deactivate consent types. A Consent Type represents a specific category or classification of consent. With capabilities to add new consent types, retrieve existing ones, obtain supported consent statuses, and update specific consent types, it ensures a comprehensive management of consent-related information. By utilizing HTTP PATCH requests, it facilitates partial modifications to consent configurations. This functionality enhances flexibility and provides greater control over consent configurations. The flexible nature of these methods offers greater control over consent configurations and ensures that user consent is accurately managed and remains compliant with diverse data privacy regulations.

MyPreferences serves as a universal consent repository managing consents around an individual or device (IoT) across any data category. 

The Consents API suite allows you to create, update, and deactivate consent types. A Consent Type represents a specific category or classification of consent. With capabilities to add new consent types, retrieve existing ones, obtain supported consent statuses, and update specific consent types, it ensures a comprehensive management of consent-related information. 

By utilizing HTTP PATCH requests, it facilitates partial modifications to consent configurations. This functionality enhances flexibility and provides greater control over consent configurations. The flexible nature of these methods offers greater control over consent configurations and ensures that user consent is accurately managed and remains compliant with diverse data privacy regulations.

Contact Types allow you to classify your contacts based on the context or purpose of their communication. By assigning specific contact types, such as &quot;Home email,&quot; &quot;Work email,&quot; &quot;Home phone,&quot; or &quot;Work phone,&quot; you can easily differentiate and organize your customer contacts according to their respective roles and usage as determined by the individual.The <code class="slate-code">Name </code>and <code class="slate-code">Description </code>fields on all Contact Types support localization which helps you configure them in any language to support multilingual customer experiences.Preferences on a profile are always associated with a Type. Types are broadly classified into two categories:<h3 class="slate-h3">Contact Element Types</h3>As the name suggests, contact element types are used for associating contacts for a specific communications channel, specifically Email, Phone, SMS, and Mail.Let&apos;s consider the example of email. Clients can define distinct email types, such as &quot;Work,&quot; &quot;Home,&quot; and &quot;Emergency.&quot; By doing so, users can assign specific email addresses to each type and also store preferences or associate consents accordingly.Clients can define consent settings for each email type, indicating whether they allow or disallow certain types of communication or data sharing. For instance, a user may grant consent for work-related emails to be shared with colleagues within the company but restrict the sharing of personal emails with third parties.<h3 class="slate-h3">Identity Types</h3>Identity Types or Id Types include CustomerTypes, AlternateId Types, and Group Types. Customer Types are used to classify profiles based on the type of customer. For example, a contact can be classified as a Customer or a Prospect. It is a required data element on every profile. Preferences which are stored on a profile that are not connected to a contact element type are stored using the customer type.Alternate ID Types are used for associating additional identifiers that help you uniquely identify a profile across other systems. For example, customer identifiers from other applications such as Salesforce, Marketo, or Facebook can be stored as Alternate Ids. Alternate ID values are unique by Alternate ID Type across all profiles.Group Types are used for classifying Groups. For example, you can set up groups named “Family”, “Football Fans”, “Employee”, etc. which can be used to connect a set of user profiles based on collective interests and characteristics. When assigning a user profile to a group, you pass in a Group Name and associate it with any of the available group types. You can also designate a profile as “Primary” within a group. When driving preference collection touchpoints, you can retrieve all profiles that are a part of a group using the Profile ID or a contact element of the primary profile associated with that group.

Contact Types allow you to classify your contacts based on the context or purpose of their communication. By assigning specific contact types, such as "Home email," "Work email," "Home phone," or "Work phone," you can easily differentiate and organize your customer contacts according to their respective roles and usage as determined by the individual.

fields on all Contact Types support localization which helps you configure them in any language to support multilingual customer experiences.

Preferences on a profile are always associated with a Type. Types are broadly classified into two categories:

As the name suggests, contact element types are used for associating contacts for a specific communications channel, specifically 

Let's consider the example of email. Clients can define distinct email types, such as "Work," "Home," and "Emergency." By doing so, users can assign specific email addresses to each type and also store preferences or associate consents accordingly.

Clients can define consent settings for each email type, indicating whether they allow or disallow certain types of communication or data sharing. For instance, a user may grant consent for work-related emails to be shared with colleagues within the company but restrict the sharing of personal emails with third parties.

 are used to classify profiles based on the type of customer. For example, a contact can be classified as a 

is a required data element on every profile. Preferences which are stored on a profile that are not connected to a contact element type are stored using the customer type.

 are used for associating additional identifiers that help you uniquely identify a profile across other systems.  For example, customer identifiers from other applications such as Salesforce, Marketo, or Facebook can be stored as Alternate Ids. Alternate ID values are unique by Alternate ID Type across all profiles.

 are used for classifying Groups. For example, you can set up groups named “Family”, “Football Fans”, “Employee”, etc. which can be used to connect a set of user profiles based on collective interests and characteristics. When assigning a user profile to a group, you pass in a Group Name and associate it with any of the available group types. You can also designate a profile as “Primary” within a group. When driving preference collection touchpoints, you can retrieve all profiles that are a part of a group using the Profile ID or a contact element of the primary profile associated with that group.

Custom Fields help you expand and enrich the collection of user profile data throughout the customer journey. A custom field can be one of the following types: Text, Numeric, DateTime, and SelectList. A picklist is required for SelectList custom fieldsWhen creating custom fields, you can mark them as required and designate update rules for each field. These update rules are enforced by the API when custom fields are added or updated on a profile. The following updates are currently available for implementation.• <code class="slate-code">Always (default)</code>: Always updates the value
• <code class="slate-code">If Current Value Is Blank:</code> Only updates if existing value on the custom field is blank
• <code class="slate-code">If New Value Is Not Blank:</code> Only updates if the incoming value is not blank
• <code class="slate-code">Never:</code> Once added to a profile, the field cannot be updated or removed

Custom Fields help you expand and enrich the collection of user profile data throughout the customer journey. A custom field can be one of the following types: 

. A picklist is required for SelectList custom fields

When creating custom fields, you can mark them as required and designate update rules for each field. These update rules are enforced by the API when custom fields are added or updated on a profile. The following updates are currently available for implementation.

 Only updates if existing value on the custom field is blank
• 

Only updates if the incoming value is not blank
• 

Once added to a profile, the field cannot be updated or removed

Add one or more custom fields of type datetime to capture date and/or time values on profiles.

to capture date and/or time values on profiles.

Create datetime custom fields

A collection of meta data describing the requirements for collecting DateTime data in a custom field.

DateTimeFields

Content-Type

This is your organization’s MyPreferences Account Id. A 404 is returned if this value is invalid.

clientId

A collection of Meta data describing the requirements for collecting DateTime data in a custom field.

The request was successful and resulted in the creation of a new resource. The newly created resource can be referenced by its specific URI returned in the Location header field.

The request was invalid and cannot be processed. This may be a result of a malformed request. You must update the request before trying again.

Authentication credentials are missing or incorrect. You must verify your ClientId, UserId, and Authorization Scheme before trying again.

The authentication credentials were insufficient to grant access to the requested resource. In most cases, your user may not have the appropriate permissions to access the requested resource. Verify User Group permissions for your user before trying again.

The request could not be completed due to a conflict with the current state of the target resource. In most cases, an instance with the same already exists on the target resource. You must update the request before trying again.

The server encountered an unexpected condition that prevented it from fulfilling the request. Notify PossibleNOW Support if it’s a continuous occurrence.

This method allows you to retrieve a specific custom field or all custom fields of type <code class="slate-code">datetime</code>. Use the optional query parameter <code class="slate-code">locale </code>to only retrieve the collection of localized fields for a specific locale across all custom fields. If none of the custom fields have a localized field collection for the specified locale, the HTTP status code of <code class="slate-code">404-Not Found </code>is returned.

This method allows you to retrieve a specific custom field or all custom fields of type 

to only retrieve the collection of localized fields for a specific locale across all custom fields. If none of the custom fields have a localized field collection for the specified locale, the HTTP status code of 

Retrieve datetime custom fields

Optional custom DateTime field Id. If specified, only the custom DateTime field with this Id will be returned. Default value is 0.

Optional locale. If specified, only custom DateTime fields associated with the locale are returned.

locale

The requested resource cannot be found.  Most errors in this category are returned when a resource specified on the URL path is not found. In certain instances, it is also returned when a parameter specified in the request body is also not found.

The server is unable to handle your request due to a temporary condition. You must delay your request for some time before trying again. Notify PossibleNOW Support if it’s a continuous occurrence.

Add one or more custom fields of type numeric to capture numeric values on profiles.

Create numeric custom fields

A collection of Meta data describing the requirements for collecting numeric data in a custom field.

NumericFields

This method allows you to retrieve a specific custom field or all custom fields of type <code class="slate-code">numeric</code>. Use the optional query parameter <code class="slate-code">locale </code>to only retrieve the collection of localized fields for a specific locale across all custom fields. If none of the custom fields have a localized field collection for the specified locale, the HTTP status code of <code class="slate-code">404-Not Found </code>is returned.

Retrieve numeric custom fields

Optional custom Numeric field Id. If specified, only the custom Numeric field with this Id will be returned. Default value is 0.

Optional locale. If specified, only custom numeric fields associated with the locale are returned.

Add one or more custom fields of type SelectList to create interactive experiences where users can select one or more items from a predefined list. You must have at least one picklist created that you can associate with the SelectList custom field.

Add one or more custom fields of type SelectList to create interactive experiences where users can select one or more items from a predefined list.  You must have at least one picklist created that you can associate with the SelectList custom field.

Create selectlist custom fields

A collection of Meta data describing the requirements for collecting single select/radio button, multi-select/checkbox data in a custom field.

SelectListFields

A collection of Meta data describing the requirements for collecting alphanumeric data in a custom field.

TextFields

This method allows you to retrieve a specific custom field or all custom fields of type <code class="slate-code">SelectList</code>. Use the optional query parameter <code class="slate-code">locale </code>to only retrieve the collection of localized fields for a specific locale across all custom fields. If none of the custom fields have a localized field collection for the specified locale, the HTTP status code of <code class="slate-code">404-Not Found </code>is returned.

Retrieve selectlist custom fields

Optional custom SelectList field Id. If specified, only the custom SelectList field with this Id will be returned. Default value is 0.

Optional locale. If specified, only custom select list fields associated with the locale are returned.

Add one or more custom fields of type text to capture text data on profiles.

Create text custom fields

This method allows you to retrieve a specific custom field or all custom fields of type <code class="slate-code">Text</code>. Use the optional query parameter <code class="slate-code">locale </code>to only retrieve the collection of localized fields for a specific locale across all custom fields. If none of the custom fields have a localized field collection for the specified locale, the HTTP status code of <code class="slate-code">404-Not Found </code>is returned.

Retrieve text custom fields

Optional custom Text field Id. If specified, only the custom text field with this Id will be returned. Default value is 0.

Optional locale. If specified, only custom text fields associated with the locale are returned.

This method will retrieve all update rules that can be applied on a custom field.Update rules specify how MyPreferences should update custom field values when adding or updating profiles. If you don&apos;t specify an update rule when creating a custom field, it defaults to <code class="slate-code">always</code>.The following update rules are available:
• <code class="slate-code">Always (default):</code> Always updates the value
• <code class="slate-code">If Current Value Is Blank: </code>Only updates if existing value on the custom field is blank
• <code class="slate-code">If New Value Is Not Blank:</code> Only updates if the incoming value is not blank
• <code class="slate-code">Never:</code> Once added to a profile, the field cannot be updated or edited

This method will retrieve all update rules that can be applied on a custom field.

Update rules specify how MyPreferences should update custom field values when adding or updating profiles. If you don't specify an update rule when creating a custom field, it defaults to 

The following update rules are available:
• 

Only updates if existing value on the custom field is blank
• 

 Only updates if the incoming value is not blank
• 

Once added to a profile, the field cannot be updated or edited

Retrieve update rules

A collection of Update Rules that can be associated with a Profile.

UpdateRules

This method allows you to retrieve a specific custom field or all custom fields irrespective of their type. Use the optional query parameter <code class="slate-code">locale </code>to only retrieve the collection of localized fields for a specific locale across all custom fields. If none of the custom fields have a localized field collection for the specified locale, the HTTP status code of <code class="slate-code">404-Not Found </code>is returned.

This method allows you to retrieve a specific custom field or all custom fields irrespective of their type. Use the optional query parameter 

Retrieve custom fields

Optional custom field Id. If specified, only the custom field with this Id will be returned. Default value is 0.

Optional locale. If specified, only custom fields associated with the locale are returned.

This method allows you to update a single custom field of type DateTime by providing the corresponding Id parameter.The HTTP PATCH request method applies partial modifications to a resource. Click <a href="https://datatracker.ietf.org/doc/html/rfc6902" target="_blank">here</a> to learn about using PATCH.The MyPreferences API supports <code class="slate-code">add</code>, <code class="slate-code">replace</code>, <code class="slate-code">remove</code>, and <code class="slate-code">test </code>PATCH operations. The API does not support <code class="slate-code">move </code>and <code class="slate-code">copy </code>PATCH operations. In the JSON body of your request, send the op, path, and value parameters:<ul class="slate-ul"><li class="slate-li">op denotes the type of operation to execute such as add, replace, remove, or test.</li><li class="slate-li">path denotes the path of the target location on the resource to update.</li><li class="slate-li">value denotes the value to apply.</li></ul><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 >When removing multiple elements from an array object, send the remove operations in descending order to keep the indices intact.</div></div>

This method allows you to update a single custom field of type 

by providing the corresponding Id parameter.

The HTTP PATCH request method applies partial modifications to a resource. Click 

PATCH operations. The API does not support 

PATCH operations. In the JSON body of your request, send the 

Update datetime custom field

MinDate

MaxDate

DefaultValue

Read-only system fields returned as part of an API response. These are updated automatically when a profile is created or modified.

Edited

Name

LocalizedDisplayNames

Description

UpdateRuleId

Determines the display order of the field on customer-facing user interfaces.

DisplayOrder

Determines whether the custom field is required when creating or replacing a profile. When set to TRUE, the field cannot be removed from the profile.

IsRequired

Allows custom fields to exist with a blank value on a profile. When set to FALSE, the custom field must be accompanied by a non-blank value when adding or updating a profile. This property works together with UpdateRules.

AllowBlanks

IsActive

This method allows you to update a single custom field of type Numeric by providing the corresponding Id parameter.The HTTP PATCH request method applies partial modifications to a resource. Click <a href="https://datatracker.ietf.org/doc/html/rfc6902" target="_blank">here</a> to learn about using PATCH.The MyPreferences API supports <code class="slate-code">add</code>, <code class="slate-code">replace</code>, <code class="slate-code">remove</code>, and <code class="slate-code">test </code>PATCH operations. The API does not support <code class="slate-code">move </code>and <code class="slate-code">copy </code>PATCH operations.In the JSON body of your request, send the op, path, and value parameters:<ul class="slate-ul"><li class="slate-li">op denotes the type of operation to execute such as add, replace, remove, or test.</li><li class="slate-li">path denotes the path of the target location on the resource to update.</li><li class="slate-li"><div style="position:relative">value denotes the value to apply.</div></li></ul><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 >Note: When removing multiple elements from an array object, send the remove operations in descending order to keep the indices intact.</div></div>

PATCH operations.In the JSON body of your request, send the 

Update numeric custom field

MinValue

MaxValue

DecimalPlaces

Stores the field's input mask definition. It will be used to drive data collection on a UI.

FieldMask

Id associated with the update rule.
1: The value can be added, changed, or cleared without restriction.
2: Once a value is added, the field becomes uneditable. It cannot be changed or cleared.
4: Once a value is added, it can be edited, but cannot be cleared.
5: Once added to a profile, the field immediately becomes uneditable. It cannot be changed or cleared.


Allows custom fields to exist with a blank value on a profile. When set to FALSE, the custom field must be accompanied by a non-blank value when adding or updating a profile.

This method allows you to update a single custom field of type Text by providing the corresponding Id parameter.The HTTP PATCH request method applies partial modifications to a resource. Click <a href="https://datatracker.ietf.org/doc/html/rfc6902" target="_blank">here</a> to learn about using PATCH.The MyPreferences API supports <code class="slate-code">add</code>, <code class="slate-code">replace</code>, <code class="slate-code">remove</code>, and <code class="slate-code">test </code>PATCH operations. The API does not support <code class="slate-code">move </code>and <code class="slate-code">copy </code>PATCH operations.In the JSON body of your request, send the op, path, and value parameters:<ul class="slate-ul"><li class="slate-li">op denotes the type of operation to execute such as add, replace, remove, or test.</li><li class="slate-li">path denotes the path of the target location on the resource to update.</li><li class="slate-li">value denotes the value to apply.</li></ul><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 >Note: When removing multiple elements from an array object, send the remove operations in descending order to keep the indices intact.</div></div>

 by providing the corresponding Id parameter.

PATCH operations.In the JSON body of your request, send the op, path, and value parameters:

Update text custom field

MinLength

MaxLength

An optional regular expression that can be used to validate a field on update.

RegEx

Determines the display order of the field on customer-facing user interfaces.Determines the display order of the field when driving preference collection touchpoints.

This method allows you to update a single custom field of type SelectList by providing the corresponding Id parameter.The HTTP PATCH request method applies partial modifications to a resource. Click <a href="https://datatracker.ietf.org/doc/html/rfc6902" target="_blank">here</a> to learn about using PATCH.The MyPreferences API supports <code class="slate-code">add</code>, <code class="slate-code">replace</code>, <code class="slate-code">remove</code>, and <code class="slate-code">test </code>PATCH operations. The API does not support <code class="slate-code">move </code>and <code class="slate-code">copy </code>PATCH operations.In the JSON body of your request, send the op, path, and value parameters:<ul class="slate-ul"><li class="slate-li">op denotes the type of operation to execute such as add, replace, remove, or test.</li><li class="slate-li">path denotes the path of the target location on the resource to update.</li><li class="slate-li">value denotes the value to apply.</li></ul><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 >Note: When removing multiple elements from an array object, send the remove operations in descending order to keep the indices intact.</div></div>

Update selectlist custom field

PicklistId

DisplayType

DefaultState

Group Types are used for classifying Groups. For example, you can set up groups named “Family”, “Football Fans”, “Employee”, etc. which can be used to connect a set of user profiles based on collective interests and characteristics. When assigning a user profile to a Group, you pass in a Group Name and associate it with any of the available Group Types.You can also designate a profile as “Primary” within a group. When driving customer 
experiences, you can retrieve all profiles that are a part of a group using the Profile Id or any contact element of the primary profile associated with that group.
<div style="text-align:center"><img src="https://theneo-prod-public.s3.amazonaws.com/images-1688698612263.PNG" alt="" id="1688698612461" width="418"/></div>

Group Types are used for classifying Groups. For example, you can set up groups named “Family”, “Football Fans”, “Employee”, etc. which can be used to connect a set of user profiles based on collective interests and characteristics. When assigning a user profile to a Group, you pass in a Group Name and associate it with any of the available Group Types.

You can also designate a profile as “Primary” within a group. When driving customer 
experiences, you can retrieve all profiles that are a part of a group using the Profile Id or any contact element of the primary profile associated with that group.


Picklists are sets of name-value pairs that are associated with a SelectList custom field. The <code class="slate-code">Name </code>field within a picklist supports localization, enabling the creation of multilingual customer experiences. The corresponding <code class="slate-code">value </code>is stored along with the custom field.SelectList custom fields configured with a display type of “multi-select” can accommodate multiple values. Multiple values sent through the MyPreferences API are delimited using “::” double colon.

are sets of name-value pairs that are associated with a SelectList custom field. The 

field within a picklist supports localization, enabling the creation of multilingual customer experiences. The corresponding 

SelectList custom fields configured with a display type of “multi-select” can accommodate multiple values. Multiple values sent through the MyPreferences API are delimited using “::” double colon.

Tags help you organize and categorize profiles based on specific pieces of information associated with your customer and non-customer profiles. For example, you can tag users as Influencers or Reward members and retrieve profiles that match on those specific values.
Tags are unique and always exist within a context of a profile. You can add and delete tags without affecting other profile information.

Tags help you organize and categorize profiles based on specific pieces of information associated with your customer and non-customer profiles. For example, you can tag users as 

 and retrieve profiles that match on those specific values.


Tags are unique and always exist within a context of a profile. You can add and delete tags without affecting other profile information.

<a href="https://pmstg.mypreferences.com/API/3/Help" target="_blank">The Preference Configuration APIs</a> allow you to retrieve preference configuration data with ease for driving personalized preference collection experiences across customer touchpoints. Using these API&apos;s, you can define and manage all aspects of preference configuration which includes the creation of Programs, Filters, Program Groups, Frequency Options, Preference Attributes, Custom Properties, and Locales. Typically, these API&apos;s are used in conjunction with Profile Configuration API&apos;s to create holistic zero-party data experiences that encompass customer demographics, psychographics, preferences, consents, feedback, and other data points.

 allow you to retrieve preference configuration data with ease for driving personalized preference collection experiences across customer touchpoints. Using these API's, you can define and manage all aspects of preference configuration which includes the creation of 

Typically, these API's are used in conjunction with Profile Configuration API's to create holistic zero-party data experiences that encompass customer demographics, psychographics, preferences, consents, feedback, and other data points.

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.Using the Data API&apos;s, you can use any data point on a profile to retrieve the profile. Please note that using contact elements, custom fields, groups, and tags to retrieve a profile may result in multiple matching profiles being returned.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.

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.

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.

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.

Sections