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 

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.

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, device profile, feedback and any other pieces of zero-party data collected along the customer journey.<div style="text-align:center"><img src="https://theneo-prod-public.s3.amazonaws.com/images-1688845178607.PNG" alt="Data Organization in MyPreferences" id="1688845178630"/></div>

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, device profile, feedback and any other pieces of zero-party data collected along the customer journey.

This method allows you to submit a user’s profile, preference, and consent information in a single call to create a unique profile record. The response will include a system generated <code class="slate-code">profileId </code>that can be used to retrieve or edit the profile later.

This method allows you to submit a user’s 

information in a single call to create a unique profile record. The response will include a system generated 

that can be used to retrieve or edit the profile later.

Add profile

A collection of consents associated with the User Profile.

A collection of Custom Fields associated with the profile.

CustomFields

A collection of Groups associated with the profile.

A collection of Tags associated with the profile.

ProfileTags

A collection of mailing addresses associated with the profile. The address collection can also include any preferences and consents associated with it.

Addresses

A collection of email addresses associated with the profile. The email collection can also include any preferences and consents associated with it.

Emails

A collection of phone numbers associated with the profile. The phone number collection can also include any preferences and consents associated with it.

PhoneNumbers

A collection of preferences associated with the User Profile. Profile preferences are tied to the user’s profile. These preferences are not associated with any contact element on the profile.

ProfilePreferences

Read-Only Id associated with the Profile.

ProfileId

Defines whether the item is Active or Inactive.

IsActive

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

Edited

An optional field for clients to use at their discretion to accommodate scenarios in which customer profile verification is performed.

RegistrationConfirmed

An identifier used to classify a person by the type of customer. For example: Retail, Commercial, or Marketing.

CustomerType

Specifies whether to retain the contact element consents or deactivate them. To retain the contact element consents, set the value as True. If set to False, the contact element consents will be deactivated. This setting defaults to True, if not specified.

PreserveConsents

Specifies whether to retain the preferences or deactivate them. To retain the preferences, set the value as True. If set to False, the preferences will be deactivated. This setting defaults to True, if not specified.

PreservePreferences

CustomerName

DefaultLocale

Read-Only field. 'Complete' if the record has been processed otherwise 'Pending Update'.

UpdateStatus

An optional parameter that can be passed when deactivating a profile.

ReasonCode

A collection of additional unique identifiers that can be associated with a profile. For example, customer identifiers from other applications such as Salesforce, Marketo or Facebook can be stored as AlternateIds.

AlternateIds

Content-Type

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

clientId

AlternateId

AlternateIdType

SubmittedUtcTime

Once the request is received, it is queued for processing and a 202 response is returned with the UpdateStatus of "Pending Update". When processing is completed, the profile is updated. Any subsequent GET operations to retrieve the profile will include a value for the UpdateStatus of either "Complete" or "Pending Update".

The request was invalid and cannot be processed. This error may occur as a result of a malformed or syntactically incorrect 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.

Using this method, you can update a profile directly by utilizing the known profileId without the need to retrieve the profile first. It performs an update operation on all data elements included in the request. Any properties that are not included in your request, but are already present on the profile, will remain unaffected and unchanged.

Using this method, you can update a profile directly by utilizing the known profileId without the need to retrieve the profile first. It performs an update operation on all data elements included in the request. Any properties that are not included in your request, but are already present on the profile, will remain unaffected and unchanged.

Update profile

A collection of Additional unique identifiers that can be associated with a profile. For example, customer identifiers from other applications such as Salesforce, Marketo or Facebook can be stored as AlternateIds.

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

Id of the profile to associate the preferences with.

profileId

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.

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.

This method allows you to permanently delete a profile and all its associated data. It&apos;s important to note that the delete operation is irreversible, so careful consideration is advised before proceeding.

This method allows you to permanently delete a profile and all its associated data. It's important to note that the delete operation is irreversible, so careful consideration is advised before proceeding.

Delete profile

Id associated with the profile that you want to delete permanently.

An optional parameter that can be used to store the reason for deletion.

reasonCode

The request was successfully processed but there is no content to return.

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. See error description for more details.

This method is used for inserting and updating a profile using the provided <code class="slate-code">alternate ID</code> and <code class="slate-code">alternateIdType</code> in the request. If the combination of <code class="slate-code">AlternateId</code> and <code class="slate-code">AlternateId Type</code> is found on an existing profile, the profile will be updated with the information provided in the request. In case there is no existing profile with the specified <code class="slate-code">alternateId</code> and <code class="slate-code">alternateIdType</code>, the method will perform an insert operation to create a new profile.

This method is used for inserting and updating a profile using the provided 

 is found on an existing profile, the profile will be updated with the information provided in the request. In case there is no existing profile with the specified 

Update profile by alternate id

This is the value that uniquely identifies the profile that is being retrieved.

alternateId

Value that identifies the type of alternate id that is being accessed.

alternateIdType

Once the request is received, it is queued for processing and a 202 response is returned with the UpdateStatus of "Pending Update". When processing is completed, the profile is updated. Any subsequent GET operations to retrieve the profile will return with an UpdateStatus of "Complete".

This method will return a single user profile that matches the <code class="slate-code">AlternateId </code>and <code class="slate-code">alternateIdType </code>combination specified in the request. The response will include all active consents, custom fields, groups, tags, and preferences for which you have appropriate permissions. Inactive data elements across all objects are not returned.

This method will return a single user profile that matches the 

for which you have appropriate permissions. Inactive data elements across all objects are not returned.

Retrieve profile by alternate id

Name of the Alternate Id type associated with the specified Alternate Id

Alternate Id value that uniquely identifies the profile that is being retrieved.

Boolean flag, when set to true, returns both implied and expressed preferences.  Expressed preferences are explicitly stated by individuals, while implied preferences are inherited from the parent Filter when no explicit preference is provided.  The Match Type field on a preference record indicates whether a preference is expressed or implied. This distinction is  applicable only when the Preference Propagation feature is enabled in your account. Otherwise, all preferences are output with the Match Type value of "expressed."

implied

If set to true, returns active and inactive Alternate Ids and Contact Elements. The default setting is false.

matchInactive

This method allows for partial modifications to be applied to a specific profile using the combination of the <code class="slate-code">alternateId </code>and <code class="slate-code">alternateIdType </code>parameters. The profile will only be updated with the information specified in the path and the values included in the request body.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"><div style="position:relative">op denotes the type of operation to execute such as add, replace, remove, or test.</div></li><li class="slate-li"><div style="position:relative">path denotes the path of the target location on the resource to update.</div></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>

This method allows for partial modifications to be applied to a specific profile using the combination of the 

parameters. The profile will only be updated with the information specified in the 

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

PATCH operations. The API does not support 

In the JSON body of your request, send the 

Update profile by alternate id (PATCH))

A collection of PATCH operations that you want to perform on the object.

Operations

Name of the Alternate Id type associated with the specified Alternate Id.

Once the request is received, it is queued for processing and a 202 response is returned with the UpdateStatus of "Pending Update". When processing is completed, a new profile is created. Any subsequent GET operations to retrieve the profile will return with an UpdateStatus of "Complete".

By using this method, you can completely replace a profile by matching on the <code class="slate-code">alternateId </code>and <code class="slate-code">alternateIdType </code>parameters. The original information stored in the profile will be overwritten with the data provided in the request.It&apos;s important to note that properties and collections not included in your request will be treated as blank, and will be excluded from the updated profile.

By using this method, you can completely replace a profile by matching on the 

parameters. The original information stored in the profile will be overwritten with the data provided in the request.

It's important to note that properties and collections not included in your request will be treated as blank, and will be excluded from the updated profile.

Update profile by alternate id (PUT)

This method will return a single user profile that matches the <code class="slate-code">profileId </code>specified in the request. The response will include all active consents, custom fields, groups, tags, and preferences for which you have appropriate permissions. Inactive data elements across all objects are not returned.

for which you have appropriate permissions. Inactive data elements across all objects are not returned. 

Retrieve profile by profile id

This method allows you to overwrite a profile by specifying the corresponding <code class="slate-code">profileId</code>.The original information contained in the profile will be overwritten by the information contained in the request. Properties and collections that are not included in the PUT request will be considered blank, and will no longer be included in the profile.

This method allows you to overwrite a profile by  specifying the corresponding 

The original information contained in the profile will be overwritten by the information contained in the request. Properties and collections that are not included in the PUT request will be considered blank, and will no longer be included in the profile.

Update profile (PUT)

The PATCH method applies partial modifications to a single profile specified by the <code class="slate-code">profileId </code>parameter. The profile will only be updated with the information specified in the path and the values included in the request body.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>

The PATCH method applies partial modifications to a single profile specified by the 

parameter. The profile will only be updated with the information specified in the path and the values included in the request body.

Update profile (PATCH)

This method will return complete consent history for a single profile using the <code class="slate-code">profileId</code> parameter. Only the basic profile information and consent history will be returned. Elements like custom fields, groups, tags, and preferences will not be included in the response. Consent history will be returned in ascending order by Consent Type, Version, and Modified date.

This method will return complete consent history for a single profile using the 

Only the basic profile information and consent history will be returned. Elements like custom fields, groups, tags, and preferences will not be included in the response. Consent history will be returned in ascending order by 

Retrieve historical consents by profile id

This method will return complete consent history associated with a specific profile using the combination of the <code class="slate-code">alternateId </code>and <code class="slate-code">alternateIdType </code>parameters. Only the basic profile information and consent history will be returned. Custom fields, groups, tags, and preferences will not be included in the response. Consent history will be returned in ascending order by Consent Type, Version, and Modified date.

This method will return complete consent history associated with a specific profile using the combination of the 

Only the basic profile information and consent history will be returned. 

will not be included in the response. Consent history will be returned in ascending order by 

Retrieve historical consents by alternate id

This method retrieves the complete history of contact elements for a single profile, including any attached consent associations. Profile-only consents, custom fields, groups, tags, and preferences will not be returned.

This method retrieves the complete history of contact elements for a single profile, including any attached consent associations. 

Retrieve historical contact elements by profile id

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

Using the combination of the <code class="slate-code">alternateId </code>and <code class="slate-code">alternateIdType </code>parameters, this method retrieves complete history of contact elements for a single profile, including any attached consent associations. Profile-only consents, custom fields, groups, tags, and preferences will not be returned.

parameters, this method retrieves complete history of contact elements for a single profile, including any attached consent associations. 

Retrieve historical contact elements by alternate id

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.

This method will return complete custom field history for a single profile using the <code class="slate-code">profileId</code> parameter. Only the basic profile information and custom field history will be returned. Elements like consents, groups, tags, and preferences will not be included in the response. Custom field history will be returned in ascending order by Modified date.

This method will return complete custom field history for a single profile using the 

Only the basic profile information and custom field history will be returned. Elements like 

will not be included in the response. Custom field history will be returned in ascending order by 

Retrieve historical custom fields by profile id

Using the combination of the <code class="slate-code">alternateId </code>and <code class="slate-code">alternateIdType </code>parameters, this method retrieves complete history of custom fields for a single profile. Consents, custom fields, groups, tags, and preferences will not be returned. Custom field history will be returned in ascending order by Modified date.

parameters, this method retrieves complete history of custom fields for a single profile. 

will not be returned. Custom field history will be returned in ascending order by 

Retrieve historical custom fields by alternate id

This method will return current and historical preferences for a single profile using the <code class="slate-code">profileId</code> parameter. Only the basic profile information, contacts, and preference history will be returned. Custom fields, groups, tags, and consents will not be included in the response.

This method will return current and historical preferences for a single profile using the 

Only the basic profile information, contacts, and preference history will be returned. 

Retrieve historical preferences by profile id

To limit the results to preferences assocated with the filter.

Sections