Overview
On this page
- Overview
Experience API
On this page
- Experience API
Data API
On this page
- Data API
Integration API
On this page
- Integration API
User Management
On this page
- User Management
POST
Create address typeGET
Retrieve address typesPATCH
Update address typePOST
Create alternate Id typesGET
Retrieve alternate Id typesPATCH
Update alternate Id typePOST
Create customer typesGET
Retrieve customer typesPATCH
Update customer typePOST
Create email typesPATCH
Update email typeGET
Retrieve email typesPOST
Create phone typesGET
Retrieve phone typesPATCH
Update phone typePOST
Create datetime custom fieldsGET
Retrieve datetime custom fieldsPOST
Create numeric custom fieldsGET
Retrieve numeric custom fieldsPOST
Create selectlist custom fieldsGET
Retrieve selectlist custom fieldsPOST
Create text custom fieldsGET
Retrieve text custom fieldsGET
Retrieve update rulesGET
Retrieve custom fieldsPATCH
Update datetime custom fieldPATCH
Update numeric custom fieldPATCH
Update text custom fieldPATCH
Update selectlist custom fieldPOST
Create profileGET
Retrieve profile by profile idGET
Retrieve profile by alternate idGET
Retrieve profiles by phoneGET
Retrieve profiles by emailGET
Retrieve profiles by addressGET
Retrieve profiles by nameGET
Retrieve profiles by partial nameGET
Retrieve profiles by custom fieldsGET
Retrieve profiles by SelectList custom fieldsGET
Retrieve profiles by tagsGET
Retrieve profiles by consent attributesGET
Retrieve profiles by preference attributesGET
Retrieve group profiles by profile idGET
Retrieve group profiles by alternate idGET
Retrieve group profiles by phone numberGET
Retrieve group profiles by email addressGET
Retrieve group profiles by group namePOST
Update profile (POST)PUT
Update profile (PUT)PATCH
Update profile (PATCH)POST
Update profile by alternate id (POST)PUT
Update profile by alternate id (PUT)PATCH
Update profile by alternate id (PATCH)PUT
Archive preferencesDELETE
Delete profileGET
Retrieve historical standard fields by alternate idGET
Retrieve historical standard fields by profile idGET
Retrieve historical preferences by alternate idGET
Retrieve historical preferences by profile idGET
Retrieve historical custom fields by alternate idGET
Retrieve historical custom fields by profile idGET
Retrieve historical contact elements by alternate idGET
Retrieve historical contact elements by profile idGET
Retrieve historical consents by profile idGET
Retrieve historical consents by alternate idThe 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:
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.