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

<p class="slate-p " >The <strong class="slate-bold">Integration API </strong>suite includes asynchronous RESTful APIs for bulk import/export operations and Event APIs for retrieving event data, along with webhook subscriptions for real-time updates.</p><h4 class="slate-h4 " >Bulk API</h4><p class="slate-p " >The MyPreferences 3.0 Bulk API is a powerful and efficient asynchronous RESTful API that serves as a robust conduit for seamless data transfer between MyPreferences and various external systems within your enterprise. It ensures that you can effortlessly manage and exchange large datasets, streamlining the process of integrating zero-party data across your technology ecosystem.</p><p class="slate-p " >One of the primary advantages of the Bulk API lies in its ability to enable near-real time synchronization of customer data. This means that any updates or changes made within MyPreferences or other connected cloud-based or on-premise systems in your enterprise are swiftly propagated and reflected in the interconnected systems. As a result, your organization can maintain a consistent, up-to-date, and comprehensive view of customer data, which is essential for delivering relevant and compliant experiences.</p><h4 class="slate-h4 " >Events API</h4><p class="slate-p " >Event APIs allow you to retrieve event data by account, subscription, profile, or specific event ID based on your webhook subscriptions. They facilitate experiences which enable customers to view their activity history, recent actions, and profile updates in real-time. By retrieving data based on webhook subscriptions, these APIs allow customers to track and review any changes or interactions they have made to their profiles, ensuring they have access to the most up-to-date information about their account activities.</p>

suite includes asynchronous RESTful APIs for bulk import/export operations and Event APIs for retrieving event data, along with webhook subscriptions for real-time updates.

The MyPreferences 3.0 Bulk API is a powerful and efficient asynchronous RESTful API that serves as a robust conduit for seamless data transfer between MyPreferences and various external systems within your enterprise. It ensures that you can effortlessly manage and exchange large datasets, streamlining the process of integrating zero-party data across your technology ecosystem.

One of the primary advantages of the Bulk API lies in its ability to enable near-real time synchronization of customer data. This means that any updates or changes made within MyPreferences or other connected cloud-based or on-premise systems in your enterprise are swiftly propagated and reflected in the interconnected systems. As a result, your organization can maintain a consistent, up-to-date, and comprehensive view of customer data, which is essential for delivering relevant and compliant experiences.

Event APIs allow you to retrieve event data by account, subscription, profile, or specific event ID based on your webhook subscriptions. They facilitate experiences which enable customers to view their activity history, recent actions, and profile updates in real-time. By retrieving data based on webhook subscriptions, these APIs allow customers to track and review any changes or interactions they have made to their profiles, ensuring they have access to the most up-to-date information about their account activities.

The initiate step begins the process of bulk import. Valid requests receive an HTTPS 200 - OK response including an access token. The access token is required to stage, execute, and retrieve the status of the bulk import. It is also used for retrieving records that failed to import.

This token is only active for six hours before it expires. Once expired, it cannot be used again for staging, executing, retrieving the import status or exceptions.


The staging step is the second step in the import process where the data gets staged for initial validation. 

The response for each staging request also includes the total number of records received, number of records that were validated successfully, and the records that failed during the initial validation process. 

The **ValidationFailed** count represents the number of records that failed validation during the data staging process. User permissions are also validated during the staging process.

The Staging step can be run multiple times before an import is executed to allow for a large amount of data to be built up over time as long as the access token remains active. For example, a user can initiate an import first thing in the morning and stage data multiple times over the course of several hours. When the execute request is run, all of the data that was staged will be imported into MyPreferences.


The execute step is the last step in the import process. Once all the data is staged, run the execute request to write the data from the staging area to the MyPreferences database. 

Only records that are reported back as "Validation Successful" during the staging process will be imported. Any records that failed validation or got returned as exceptions will be ignored. A summary of the import details is included in the response once the execution step is completed. 

*Processed*, *Exceptions*, and *NotHonored* count will not be available instantly upon execution. Depending on the record count, poll the the "Retrieve Status" endpoint at regular intervals until the status is returned as “Complete”. 


Use this method to retrieve the current status of an import. One of the following statuses will be reported.

- **Initiated** - The import has been defined and is ready to accept profile records.
- **Staging** - The data is being staged. More records may be added at this stage.
- **Queued** - The import has been executed and records have been queued.
- **Processing** - The records in the import are being processed.
- **Completed** - The records have been imported.
- **Failed** - The import has failed to execute and none of the staged records were added into MyPreferences. 


During both the staging process and import execution, exceptions may occur. These exceptions can be caused by a variety of factors such as incorrect data or email addresses that do not conform to the RegEx configured on your account. You can use this method to retrieve records that encountered exceptions during the staging process so that they can be fixed and re-staged.

Exceptions encountered during the execution phase should also be retrieved using this endpoint. 


MyPreferences 3.0 v2

Sections