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

User Management

Create user

Update user

Retrieve users

MyPreferences API

MyPreferences 3.0

MyPreferences 3.0 v4

Production

Sandbox

Create 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

Segment Groups

Segments

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

The Experience APIs, also referred to as Configuration APIs, are a suite of purpose-built APIs designed to retrieve zero-party data configurations, enabling highly personalized and relevant customer experiences.With built-in localization support and flexible query parameters, these APIs allow you to fetch tailored consent, preference, and other zero-party data configurations, giving you complete control over customer experiences, from granular, micro-level interactions to full-scale 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">Preference Configuration</div></li></ul><h3 class="slate-h3 " >Building Preference and Consent Collection Experiences Made Easy!</h3>Experience APIs helps you drive the display of relevant consents, preference communications, feedback choices, and other data collection points. They are used in conjunction with Data APIs that retrieve the most up-to-date information of the individual and populate it across them.Whether you are building a Preference Center or an in-app widget to collect feedback, the user interface layout is up to your imagination. For displaying preference communications, there are several APIs that you can leverage depending on your use case. For example, to display preference communications based on a specific data point you know about an individual or if they belong to a sepcific segment, leverage the <a href="64c15c1fb735419eb78cd6bc/64c92865b735419eb79c93bb/64c92865b735419eb79c93c1" target="">GET ProgramGroups by Custom Properties</a> API. It will return all preference communications, their associated frequency choices and preference attributes, all in one single call.Check out the <a href="https://www.youtube.com/watch?v=M_QLq2Auvqc&t=526s" target="">video </a>on configuring Program Groups in MyPreferences.To display consents, use the <a href="64c15c1fb735419eb78cd6bc/64c15c1eb735419eb78ca89d/64c15c1eb735419eb78cae5a" target="">GET Consents API</a> to retrieve the list of all configured consents. Consents associated with contacts are always returned when you retrieve the<a href="64c15c1fb735419eb78cd6bc/64c15c1eb735419eb78ca8de" target=""> Contact Types</a>.Once the required configuration data is returned, link it to the actual user by retrieving their profile. Use any known data point to look up the user, but for the most accurate match, it’s best to use the Profile ID or Alternate ID.Creating a personalized and intuitive Preference Center is key to delivering a great user experience and ensuring compliance with evolving data privacy standards. Whether you&apos;re building a dedicated Preference Center or embedding feedback and consent collection within your app, Experience APIs play a central role in enabling flexibility, consistency, and accuracy.Step 1: Design the Layout — Your UI, Your Way
The visual layout and interaction model of your Preference Center is entirely customizable. Whether you&apos;re building a fully branded standalone preference center or embedding modular components within an app or website, you have complete creative freedom. The APIs provide the data and structure; the rest is up to your design vision and UX strategy.Step 2: Displaying Preference Communications
To display relevant preference communication options, you’ll want to tailor content based on what you know about the user.Use the GET ProgramGroups by Custom Properties API to retrieve preference communications based on specific data points (e.g., user interests, region, or journey stage) you know about the individual. This allows you to surface only those categories of preference communications that are applicable to that individual, offering a more contextualized and relevant experience. There are several APIs available that return preference communications, including their frequency and related attributes. You can choose the one that best fits your needs.The Programs API return one or more programs whereas the Program Groups API returns a specific category of programs.Step 3: Displaying Consents
To display and manage user consents:Use the <a href="64c15c1fb735419eb78cd6bc/64c15c1eb735419eb78ca89d/64c15c1eb735419eb78cae5a" target="">GET Consents API </a>to retrieve a list of all available consents configured in your system. Consents associated with the contact types are returned when you retrieve the relevant contact types.Consents already associated with a user are automatically returned when you retrieve the user&apos;s profile.This enables a clear view of which consents are required, optional, or already completed, empowering users to make informed choices.Step 4: Display any additional data pointsYou can display any additional data points you wish to collect, such as <a href="64c15c1fb735419eb78cd6bc/64c15c1eb735419eb78ca8b0" target="">Groups</a>, <a href="64c15c1fb735419eb78cd6bc/64c15c1eb735419eb78ca8f9" target="">Custom Fields</a>, <a href="64c15c1fb735419eb78cd6bc/64c15c1eb735419eb78ca8e0" target="">Tags</a>, and more. These data points help you better understand your users and tailor communications based on their preferences.Step 5: Merge Configuration Data with User Profile
Once you&apos;ve retrieved all configuration data (e.g., available consents, preferences, custom fields, etc.), you need to merge that with the individual’s profile data to create a personalized experience.To retrieve the profile, use the <a href="64c15c1fb735419eb78cd6c2/64c15c1eb735419eb78ca8e2/65f86bd9e777774e801abb0a" target="">GET Profile by ID</a> endpoint or retrieve the profile using alternate identifiers such as an <a href="64c15c1fb735419eb78cd6c2/64c15c1eb735419eb78ca8e2/65f8a5a0e777774e802c3462" target="">Alternate Id</a>, <a href="64c15c1fb735419eb78cd6c2/64c15c1eb735419eb78ca8e2/64c15c1fb735419eb78cc450" target="">email address</a>, <a href="64c15c1fb735419eb78cd6c2/64c15c1eb735419eb78ca8e2/66bf82e39c764331899bcf05" target="">phone number</a>, or any other known data point.This step ensures that you&apos;re populating the UI with data that&apos;s both current and specific to the user, enabling real-time personalization. It also allows the user to correct the course by reviewing and reaffirming the consents, permissions, and preferences they&apos;ve previously set, ensuring transparency and trust while keeping the experience aligned with their expectations.By combining Experience APIs for front-end display and Data APIs for profile-level accuracy, you can build a Preference Center that is not only flexible and compliant but also engaging and user-first. This modular architecture enables you to scale and evolve your interface as your data strategy and user expectations grow.<h4 class="slate-h4 " >Sample User Preference Center Flow – Profile Identification &amp; UI Handling</h4><div style="text-align:left"><img src="https://d24lr4zqs1tgqh.cloudfront.net/24ba6a6f-9e92-49cb-ac5a-76af8564cdad.jpg" style="
 width:706px;
	 height:1665px;
	 aspect-ratio:706 / 1665"
 /></div>

The Experience APIs, also referred to as Configuration APIs, are a suite of purpose-built APIs designed to retrieve zero-party data configurations, enabling highly personalized and relevant customer experiences.

With built-in localization support and flexible query parameters, these APIs allow you to fetch tailored consent, preference, and other zero-party data configurations, giving you complete control over customer experiences, from granular, micro-level interactions to full-scale preference centers and everything in between.

Building Preference and Consent Collection Experiences Made Easy!

Experience APIs helps you drive the display of relevant consents, preference communications, feedback choices, and other data collection points. They are used in conjunction with Data APIs that retrieve the most up-to-date information of the individual and populate it across them.

Whether you are building a Preference Center or an in-app widget to collect feedback, the user interface layout is up to your imagination. 

For displaying preference communications, there are several APIs that you can leverage depending on your use case. For example, to display preference communications based on a specific data point you know about an individual or if they belong to a sepcific segment, leverage the 

 API. It will return all preference communications, their associated frequency choices and preference attributes, all in one single call.

on configuring Program Groups in MyPreferences.

 to retrieve the list of all configured consents. Consents associated with contacts are always returned when you retrieve the

Once the required configuration data is returned, link it to the actual user by retrieving their profile. Use any known data point to look up the user, but for the most accurate match, it’s best to use the Profile ID or Alternate ID.

Creating a personalized and intuitive Preference Center is key to delivering a great user experience and ensuring compliance with evolving data privacy standards. Whether you're building a dedicated Preference Center or embedding feedback and consent collection within your app, Experience APIs play a central role in enabling flexibility, consistency, and accuracy.

Step 1: Design the Layout — Your UI, Your Way


The visual layout and interaction model of your Preference Center is entirely customizable. Whether you're building a fully branded standalone preference center or embedding modular components within an app or website, you have complete creative freedom. The APIs provide the data and structure; the rest is up to your design vision and UX strategy.

Step 2: Displaying Preference Communications


To display relevant preference communication options, you’ll want to tailor content based on what you know about the user.

Use the GET ProgramGroups by Custom Properties API to retrieve preference communications based on specific data points (e.g., user interests, region, or journey stage) you know about the individual. This allows you to surface only those categories of preference communications that are applicable to that individual, offering a more contextualized and relevant experience. 

There are several APIs available that return preference communications, including their frequency and related attributes. You can choose the one that best fits your needs.

The Programs API return one or more programs whereas the Program Groups API returns a specific category of programs.

to retrieve a list of all available consents configured in your system. Consents associated with the contact types are returned when you retrieve the relevant contact types.

Consents already associated with a user are automatically returned when you retrieve the user's profile.

This enables a clear view of which consents are required, optional, or already completed, empowering users to make informed choices.

Step 4: Display any additional data points

You can display any additional data points you wish to collect, such as 

, and more. These data points help you better understand your users and tailor communications based on their preferences.

Step 5: Merge Configuration Data with User Profile


Once you've retrieved all configuration data (e.g., available consents, preferences, custom fields, etc.), you need to merge that with the individual’s profile data to create a personalized experience.

 endpoint or retrieve the profile using alternate identifiers such as an 

This step ensures that you're populating the UI with data that's both current and specific to the user, enabling real-time personalization. It also allows the user to correct the course by reviewing and reaffirming the consents, permissions, and preferences they've previously set, ensuring transparency and trust while keeping the experience aligned with their expectations.

By combining Experience APIs for front-end display and Data APIs for profile-level accuracy, you can build a Preference Center that is not only flexible and compliant but also engaging and user-first. This modular architecture enables you to scale and evolve your interface as your data strategy and user expectations grow.

Sample User Preference Center Flow – Profile Identification & UI Handling

This method will add a new Group Type to the client configuration which can be associated with a Group for storing preferences.

This method will retrieve all Group Types defined by the client. Optionally you can include a locale to filter the results by a specific locale.

This method will retrieve all Group Names.

This method allows you to update a single GroupType specified by the TypeId parameter.

The HTTP PATCH request method applies partial modifications to a resource. Click [here](https://datatracker.ietf.org/doc/html/rfc6902) to learn about using PATCH.

The MyPreferences API supports add, replace, remove, and test PATCH operations. The API does not support move and copy PATCH operations.In the JSON body of your request, send the op, path, and value parameters:

- *op* denotes the type of operation to execute such as add, replace, remove, or test.
- *path* denotes the path of the target location on the resource to update.
- *value* denotes the value to apply.

Note: When removing multiple elements from an array object, send the remove operations in descending order to keep the indices intact.


Sections