Overview
Getting started with MyPreferences 3.0 Version 4 API is easy. Before we dive in, let's spend some time to learn about the supported authorization options and understand how the API library is categorized based on MyPreferences' core framework.
Using API's
Refer to the Authorization section to discover the different authorization methods supported for accessing 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 resource
POST: To create a new resource
PUT: To update (overwrite) an existing resource
PATCH: To perform partial updates to an existing resource
DELETE: To delete a resource
To access the Swagger specification of the MyPreferences API, click here.
API Categorization
The API's are categorized into three separate sets with distinct functionalities based on the application's core framework: Experiences, Data, and Connectivity.
Data Categorization
In MyPreferences, the data is organized in three main areas: Profiles, Preferences and Consents. The data elements collected in these areas coalesce to form a unified profile, capturing a comprehensive depiction of an individual's identity, preferences, and consents across all channels and interactions across their customer journey.
Profiles
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.
Preferences
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.
Consents
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.
Base URL
Production:
https://pm.mypreferences.com/Profiles/v4
Sandbox:
https://pmstg.mypreferences.com/Profiles/v4
Experience API
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.
These API's are classified as follows:
- Profile Configuration
- Preference Configuration
Endpoints
POST
GET
GET
PATCH
POST
GET
PATCH
POST
GET
PATCH
POST
GET
PATCH
POST
PATCH
GET
POST
GET
PATCH
POST
GET
POST
GET
POST
GET
POST
GET
GET
GET
PATCH
PATCH
PATCH
PATCH
POST
GET
GET
PATCH
POST
POST
GET
PATCH
GET
DELETE
GET
GET
GET
GET
GET
GET
GET
GET
GET
GET
GET
Data API
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 contact elements, custom fields, groups, and tags 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.
What made this section unhelpful for you?
Base URL
Production:
https://pm.mypreferences.com/Profiles/v4
Sandbox:
https://pmstg.mypreferences.com/Profiles/v4
What made this section unhelpful for you?
Profile
A Profile represents a unified view of a user across all channels and touchpoints. A user can be an individual, an application, or an IoT device. The profile record can contain demographic and psychographic information, consents, preferences, group associations, device profile, feedback and all other aspects of zero-party data collected along the customer journey.
What made this section unhelpful for you?
Add profile
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 profileId that can be used to retrieve or edit the profile later.
Header Parameters
Authorization token
Path Parameters
This is your organization’s MyPreferences account Id.A 404 is returned if this value is invalid.
Body Parameters
System-generated unique identifier associated with the profile. Read-only.
Defines whether the item is active or inactive.
Read-only system fields returned as part of an API response. These are updated automatically when a profile is created or modified.
Show child attributes
An optional field for clients to use at their discretion to accommodate scenarios in which customer profile verification is performed.
An identifier used to classify a person based on specific criteria. For example, it can represent their buying stage (prospect, lead, customer), firmographics (industry, company size), or any other criteria.
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.
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.
Name fields associated with the profile.
Show child attributes
Default Locale for the profile.
Shows 'Complete' if the record is processed, otherwise 'Pending Update.' Read-only.
An optional parameter used when deactivating a profile to specify the reason for deactivation.
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.
Show child attributes
A collection of mailing addresses associated with the profile. The address collection can also include any preferences and consents associated with it.
Show child attributes
A collection of email addresses associated with the profile. The email collection can also include any preferences and consents associated with it.
Show child attributes
A collection of phone numbers associated with the profile. The phone number collection can also include any preferences and consents associated with it.
Show child attributes
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.
Show child attributes
A collection of consents associated with the profile.
Show child attributes
A collection of custom fields associated with the profile.
Show child attributes
A collection of Groups associated with the profile.
Show child attributes
A collection of Tags associated with the profile.
Show child attributes
Response
Response Attributes
An additional identifier which uniquely identifies the profile.
Name of the AlternateIdType to which the AlternateId can be associated.
System-generated unique identifier associated with the profile. Read-only.
Shows 'Complete' if the record is processed, otherwise 'Pending Update.' Read-only.
DateTime when the request was submitted.
What made this section unhelpful for you?
Response
{
"AlternateId": "AM239KD99",
"AlternateIdType": "CRMID",
"ProfileId": 1,
"UpdateStatus": "Pending Update",
"SubmittedUtcTime": "2024-12-05T20:43:27.021Z"
}What made this section unhelpful for you?
Retrieve profile by profile id
This method will return a single user profile that matches the profileId specified in the request.
The response will include all active consents, custom fields, groups, tags, and preferences for which you have permissions. Inactive data elements across all objects are not returned.
Header Parameters
Authorization token
Query Parameters
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 w...
Optional parameter that, when set to true, returns consent history. When set to false, it returns only the latest consent information. Defaults to true.
Path Parameters
This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.
System generated unique identifier of the profile.
Response
Response Attributes
System-generated unique identifier associated with the profile. Read-only.
Defines whether the item is active or inactive.
Read-only system fields returned as part of an API response. These are updated automatically when a profile is created or modified.
Show child attributes
An optional field for clients to use at their discretion to accommodate scenarios in which customer profile verification is performed.
An identifier used to classify a person based on specific criteria. For example, it can represent their buying stage (prospect, lead, customer), firmographics (industry, company size), or any other criteria.
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.
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.
Name fields associated with the profile.
Show child attributes
Default Locale for the profile.
Shows 'Complete' if the record is processed, otherwise 'Pending Update.' Read-only.
An optional parameter used when deactivating a profile to specify the reason for deactivation.
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.
Show child attributes
A collection of mailing addresses associated with the profile. The address collection can also include any preferences and consents associated with it.
Show child attributes
A collection of email addresses associated with the profile. The email collection can also include any preferences and consents associated with it.
Show child attributes
A collection of phone numbers associated with the profile. The phone number collection can also include any preferences and consents associated with it.
Show child attributes
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.
Show child attributes
A collection of consents associated with the profile.
Show child attributes
A collection of custom fields associated with the profile.
Show child attributes
A collection of Groups associated with the profile.
Show child attributes
A collection of Tags associated with the profile.
Show child attributes
What made this section unhelpful for you?
Response
{
"ProfileId": 27178,
"IsActive": true,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"RegistrationConfirmed": true,
"CustomerType": "Lead",
"PreserveConsents": true,
"PreservePreferences": true,
"CustomerName": {
"FirstName": "John",
"MiddleName": "F",
"LastName": "Doe",
"Prefix": "Mr",
"Suffix": "Jr"
},
"DefaultLocale": "en_US",
"UpdateStatus": "Complete",
"ReasonCode": "",
"AlternateIds": [
{
"AlternateIdType": "Salesforce ContactId",
"AlternateId": "0031njkASSIs2kk909",
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
}
}
],
"Addresses": [
{
"Address1": "4400 River Green Parkway",
"Address2": "Suite 100",
"City": "Duluth",
"StateProvince": "GA",
"CountryCode_Numeric": "840",
"CountryCode_Alpha2": "US",
"CountryCode_Alpha3": "USA",
"PostalCode": "30096-2549",
"AddressType": "Work",
"IsActive": true,
"IsDefault": false,
"CassAddress1": "4400 RIVER GREEN PKWY",
"CassAddress2": "",
"CassCity": "DULUTH",
"CassStateProvince": "GA",
"CassPostalCode": "30096-2531",
"CassStatus": "Y",
"Country": "United States of America",
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"MissingRequiredConsents": false,
"Consents": [
{
"ConsentType": "Direct Mail Consent",
"ConsentVersion": "v1.0",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2024-10-25T13:50:40.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Lead Gen Form - 221",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
]
}
],
"AddressPreferences": [
{
"ProgramId": "in_banking_alert",
"ChannelId": "Mail",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-09-14T20:18:56.943Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_mail",
"PreferenceType": "2",
"FrequencyId": "MONTHLY",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2022-05-03T20:21:48.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": false,
"ConsentAssociations": [
{
"ConsentType": "Opt-in Consent",
"ConsentVersion": "v1",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
]
}
],
"Emails": [
{
"EmailAddressType": "Primary",
"EmailAddress": "john.doe@example.com",
"IsDefault": false,
"Consents": [
{
"ConsentType": "Global Email Marketing Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:50:40.000Z",
"ExpirationDate": "2022-10-25T13:50:40.000Z",
"Expired": true,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"EmailPreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Email",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2023-01-09T14:26:45.280Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_email",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "Nurture-11"
}
],
"CustomerDate": "2023-01-09T14:26:41.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": false,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
}
}
],
"PhoneNumbers": [
{
"PhoneType": "Home",
"PhoneNumber": "7702551021",
"PhoneNumberNumeric": 7702551021,
"IsDefault": false,
"Consents": [
{
"ConsentType": "TCPA Landline Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2023-11-02T21:23:31.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Service App",
"UpdatedVersionPending": false,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T21:23:37.023Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Agent ID - 1334"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"IsMobile": false,
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2024-02-10T13:48:18.943Z",
"ModifiedBy": "My Accounts Page"
},
"PhonePreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Phone",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-02-10T13:48:18.943Z",
"UserId": "App_Preferences_Widget_SC22",
"SourceId": "In-app Widgets",
"FilterId": "fin_banking_phone",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2024-02-10T13:48:13.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false
}
],
"ProfilePreferences": [
{
"ProgramId": "ins_payment_confirmation",
"ChannelId": "Solicit",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2021-11-17T18:44:21.707Z",
"UserId": "My Accounts Page",
"SourceId": "Default",
"FilterId": "ins_payment_app_notify",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "App Id",
"Value": "JADKYK13343KD"
}
],
"CustomerDate": "2023-11-17T18:44:12.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"Consents": [
{
"ConsentType": "CCPA Privacy Rights",
"ConsentVersion": "v4",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:28:49.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2021-11-16T20:42:08.633Z",
"CreatedBy": "Web App",
"ModifiedDate": "2022-10-25T13:28:51.343Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "CA-USA"
}
]
}
],
"CustomFields": [
{
"Name": "Interests",
"Value": "Shopping::Camping and Outdoors::Online Gaming",
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"Groups": [
{
"GroupType": "Household",
"GroupName": "Family",
"IsPrimary": true,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T15:29:15.973Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"ProfileTags": [
{
"Name": "Frequent Customer"
}
]
}What made this section unhelpful for you?
Retrieve profile by alternate id
This method will return a single user profile that matches the AlternateId and alternateIdType 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.
Header Parameters
Authorization token
Query Parameters
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 w...
If set to true, returns active and inactive Alternate Ids and Contact Elements. Must be set to true when retrieving a profile using an inactive AlternateId. The default setting is false.
Optional parameter that, when set to true, returns consent history. When set to false, it returns only the latest consent information. Defaults to true.
Path Parameters
This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.
Response
Response Attributes
System-generated unique identifier associated with the profile. Read-only.
Defines whether the item is active or inactive.
Read-only system fields returned as part of an API response. These are updated automatically when a profile is created or modified.
Show child attributes
An optional field for clients to use at their discretion to accommodate scenarios in which customer profile verification is performed.
An identifier used to classify a person based on specific criteria. For example, it can represent their buying stage (prospect, lead, customer), firmographics (industry, company size), or any other criteria.
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.
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.
Name fields associated with the profile.
Show child attributes
Default Locale for the profile.
Shows 'Complete' if the record is processed, otherwise 'Pending Update.' Read-only.
An optional parameter used when deactivating a profile to specify the reason for deactivation.
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.
Show child attributes
A collection of mailing addresses associated with the profile. The address collection can also include any preferences and consents associated with it.
Show child attributes
A collection of email addresses associated with the profile. The email collection can also include any preferences and consents associated with it.
Show child attributes
A collection of phone numbers associated with the profile. The phone number collection can also include any preferences and consents associated with it.
Show child attributes
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.
Show child attributes
A collection of consents associated with the profile.
Show child attributes
A collection of custom fields associated with the profile.
Show child attributes
A collection of Groups associated with the profile.
Show child attributes
A collection of Tags associated with the profile.
Show child attributes
What made this section unhelpful for you?
Response
{
"ProfileId": 27178,
"IsActive": true,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"RegistrationConfirmed": true,
"CustomerType": "Lead",
"PreserveConsents": true,
"PreservePreferences": true,
"CustomerName": {
"FirstName": "John",
"MiddleName": "F",
"LastName": "Doe",
"Prefix": "Mr",
"Suffix": "Jr"
},
"DefaultLocale": "en_US",
"UpdateStatus": "Complete",
"ReasonCode": "",
"AlternateIds": [
{
"AlternateIdType": "Salesforce ContactId",
"AlternateId": "0031njkASSIs2kk909",
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
}
}
],
"Addresses": [
{
"Address1": "4400 River Green Parkway",
"Address2": "Suite 100",
"City": "Duluth",
"StateProvince": "GA",
"CountryCode_Numeric": "840",
"CountryCode_Alpha2": "US",
"CountryCode_Alpha3": "USA",
"PostalCode": "30096-2549",
"AddressType": "Work",
"IsActive": true,
"IsDefault": false,
"CassAddress1": "4400 RIVER GREEN PKWY",
"CassAddress2": "",
"CassCity": "DULUTH",
"CassStateProvince": "GA",
"CassPostalCode": "30096-2531",
"CassStatus": "Y",
"Country": "United States of America",
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"MissingRequiredConsents": false,
"Consents": [
{
"ConsentType": "Direct Mail Consent",
"ConsentVersion": "v1.0",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2024-10-25T13:50:40.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Lead Gen Form - 221",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
]
}
],
"AddressPreferences": [
{
"ProgramId": "in_banking_alert",
"ChannelId": "Mail",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-09-14T20:18:56.943Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_mail",
"PreferenceType": "2",
"FrequencyId": "MONTHLY",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2022-05-03T20:21:48.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": false,
"ConsentAssociations": [
{
"ConsentType": "Opt-in Consent",
"ConsentVersion": "v1",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
]
}
],
"Emails": [
{
"EmailAddressType": "Primary",
"EmailAddress": "john.doe@example.com",
"IsDefault": false,
"Consents": [
{
"ConsentType": "Global Email Marketing Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:50:40.000Z",
"ExpirationDate": "2022-10-25T13:50:40.000Z",
"Expired": true,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"EmailPreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Email",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2023-01-09T14:26:45.280Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_email",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "Nurture-11"
}
],
"CustomerDate": "2023-01-09T14:26:41.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": false,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
}
}
],
"PhoneNumbers": [
{
"PhoneType": "Home",
"PhoneNumber": "7702551021",
"PhoneNumberNumeric": 7702551021,
"IsDefault": false,
"Consents": [
{
"ConsentType": "TCPA Landline Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2023-11-02T21:23:31.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Service App",
"UpdatedVersionPending": false,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T21:23:37.023Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Agent ID - 1334"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"IsMobile": false,
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2024-02-10T13:48:18.943Z",
"ModifiedBy": "My Accounts Page"
},
"PhonePreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Phone",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-02-10T13:48:18.943Z",
"UserId": "App_Preferences_Widget_SC22",
"SourceId": "In-app Widgets",
"FilterId": "fin_banking_phone",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2024-02-10T13:48:13.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false
}
],
"ProfilePreferences": [
{
"ProgramId": "ins_payment_confirmation",
"ChannelId": "Solicit",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2021-11-17T18:44:21.707Z",
"UserId": "My Accounts Page",
"SourceId": "Default",
"FilterId": "ins_payment_app_notify",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "App Id",
"Value": "JADKYK13343KD"
}
],
"CustomerDate": "2023-11-17T18:44:12.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"Consents": [
{
"ConsentType": "CCPA Privacy Rights",
"ConsentVersion": "v4",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:28:49.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2021-11-16T20:42:08.633Z",
"CreatedBy": "Web App",
"ModifiedDate": "2022-10-25T13:28:51.343Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "CA-USA"
}
]
}
],
"CustomFields": [
{
"Name": "Interests",
"Value": "Shopping::Camping and Outdoors::Online Gaming",
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"Groups": [
{
"GroupType": "Household",
"GroupName": "Family",
"IsPrimary": true,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T15:29:15.973Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"ProfileTags": [
{
"Name": "Frequent Customer"
}
]
}What made this section unhelpful for you?
Retrieve profiles by phone
This method will retrieve one or more profiles that match the phone number specified in the request. Use the optional query parameter phoneType to limit the returned results to a specific phone type.
This method can only return up to 50 profiles. If more than 50 matching profiles are found, the API returns a 403-Forbidden.
The response will include all active consents, custom fields, groups, tags, and preferences for which you have appropriate permissions.
Header Parameters
Authorization token
Query Parameters
The phone number digits that will be used to retrieve the profile.
Filter the response to a specific phone type.
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 w...
Boolean flag that when set to true returns both active and inactive profiles. If not included the value will default to false.
Optional parameter that, when set to true, returns consent history. When set to false, it returns only the latest consent information. Defaults to true.
Path Parameters
This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.
Response
Response Attributes
System-generated unique identifier associated with the profile. Read-only.
Defines whether the item is active or inactive.
Read-only system fields returned as part of an API response. These are updated automatically when a profile is created or modified.
Show child attributes
An optional field for clients to use at their discretion to accommodate scenarios in which customer profile verification is performed.
An identifier used to classify a person based on specific criteria. For example, it can represent their buying stage (prospect, lead, customer), firmographics (industry, company size), or any other criteria.
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.
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.
Name fields associated with the profile.
Show child attributes
Default Locale for the profile.
Shows 'Complete' if the record is processed, otherwise 'Pending Update.' Read-only.
An optional parameter used when deactivating a profile to specify the reason for deactivation.
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.
Show child attributes
A collection of mailing addresses associated with the profile. The address collection can also include any preferences and consents associated with it.
Show child attributes
A collection of email addresses associated with the profile. The email collection can also include any preferences and consents associated with it.
Show child attributes
A collection of phone numbers associated with the profile. The phone number collection can also include any preferences and consents associated with it.
Show child attributes
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.
Show child attributes
A collection of consents associated with the profile.
Show child attributes
A collection of custom fields associated with the profile.
Show child attributes
A collection of Groups associated with the profile.
Show child attributes
A collection of Tags associated with the profile.
Show child attributes
What made this section unhelpful for you?
Response
[
{
"ProfileId": 27178,
"IsActive": true,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"RegistrationConfirmed": true,
"CustomerType": "Lead",
"PreserveConsents": true,
"PreservePreferences": true,
"CustomerName": {
"FirstName": "John",
"MiddleName": "F",
"LastName": "Doe",
"Prefix": "Mr",
"Suffix": "Jr"
},
"DefaultLocale": "en_US",
"UpdateStatus": "Complete",
"ReasonCode": "",
"AlternateIds": [
{
"AlternateIdType": "Salesforce ContactId",
"AlternateId": "0031njkASSIs2kk909",
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
}
}
],
"Addresses": [
{
"Address1": "4400 River Green Parkway",
"Address2": "Suite 100",
"City": "Duluth",
"StateProvince": "GA",
"CountryCode_Numeric": "840",
"CountryCode_Alpha2": "US",
"CountryCode_Alpha3": "USA",
"PostalCode": "30096-2549",
"AddressType": "Work",
"IsActive": true,
"IsDefault": false,
"CassAddress1": "4400 RIVER GREEN PKWY",
"CassAddress2": "",
"CassCity": "DULUTH",
"CassStateProvince": "GA",
"CassPostalCode": "30096-2531",
"CassStatus": "Y",
"Country": "United States of America",
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"MissingRequiredConsents": false,
"Consents": [
{
"ConsentType": "Direct Mail Consent",
"ConsentVersion": "v1.0",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2024-10-25T13:50:40.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Lead Gen Form - 221",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
]
}
],
"AddressPreferences": [
{
"ProgramId": "in_banking_alert",
"ChannelId": "Mail",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-09-14T20:18:56.943Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_mail",
"PreferenceType": "2",
"FrequencyId": "MONTHLY",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2022-05-03T20:21:48.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": false,
"ConsentAssociations": [
{
"ConsentType": "Opt-in Consent",
"ConsentVersion": "v1",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
]
}
],
"Emails": [
{
"EmailAddressType": "Primary",
"EmailAddress": "john.doe@example.com",
"IsDefault": false,
"Consents": [
{
"ConsentType": "Global Email Marketing Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:50:40.000Z",
"ExpirationDate": "2022-10-25T13:50:40.000Z",
"Expired": true,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"EmailPreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Email",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2023-01-09T14:26:45.280Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_email",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "Nurture-11"
}
],
"CustomerDate": "2023-01-09T14:26:41.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": false,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
}
}
],
"PhoneNumbers": [
{
"PhoneType": "Home",
"PhoneNumber": "7702551021",
"PhoneNumberNumeric": 7702551021,
"IsDefault": false,
"Consents": [
{
"ConsentType": "TCPA Landline Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2023-11-02T21:23:31.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Service App",
"UpdatedVersionPending": false,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T21:23:37.023Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Agent ID - 1334"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"IsMobile": false,
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2024-02-10T13:48:18.943Z",
"ModifiedBy": "My Accounts Page"
},
"PhonePreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Phone",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-02-10T13:48:18.943Z",
"UserId": "App_Preferences_Widget_SC22",
"SourceId": "In-app Widgets",
"FilterId": "fin_banking_phone",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2024-02-10T13:48:13.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false
}
],
"ProfilePreferences": [
{
"ProgramId": "ins_payment_confirmation",
"ChannelId": "Solicit",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2021-11-17T18:44:21.707Z",
"UserId": "My Accounts Page",
"SourceId": "Default",
"FilterId": "ins_payment_app_notify",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "App Id",
"Value": "JADKYK13343KD"
}
],
"CustomerDate": "2023-11-17T18:44:12.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"Consents": [
{
"ConsentType": "CCPA Privacy Rights",
"ConsentVersion": "v4",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:28:49.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2021-11-16T20:42:08.633Z",
"CreatedBy": "Web App",
"ModifiedDate": "2022-10-25T13:28:51.343Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "CA-USA"
}
]
}
],
"CustomFields": [
{
"Name": "Interests",
"Value": "Shopping::Camping and Outdoors::Online Gaming",
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"Groups": [
{
"GroupType": "Household",
"GroupName": "Family",
"IsPrimary": true,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T15:29:15.973Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"ProfileTags": [
{
"Name": "Frequent Customer"
}
]
}
]What made this section unhelpful for you?
Retrieve profiles by email
This method will retrieve one or more profiles that match the email address specified in the request. Use the optional query parameter emailType to limit the returned results to a specific email type.
This method can only return up to 50 profiles. If more than 50 matching profiles are found, the API returns a 403-Forbidden.
The response will include all active consents, custom fields, groups, tags, and preferences for which you have appropriate permissions.
Header Parameters
Authorization token
Query Parameters
Email address that will be used to retrieve the profile.
This is to filter the results on a specific email address type as defined under "Contact Types" in MyPreferences. As examples this may include personal, employee, or shared.
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 outpu...
Boolean flag, when set to true returns both active and inactive profiles. If not included, the value will default to false.
Optional parameter that, when set to true, returns consent history. When set to false, it returns only the latest consent information. Defaults to true.
Path Parameters
This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.
Response
Response Attributes
System-generated unique identifier associated with the profile. Read-only.
Defines whether the item is active or inactive.
Read-only system fields returned as part of an API response. These are updated automatically when a profile is created or modified.
Show child attributes
An optional field for clients to use at their discretion to accommodate scenarios in which customer profile verification is performed.
An identifier used to classify a person based on specific criteria. For example, it can represent their buying stage (prospect, lead, customer), firmographics (industry, company size), or any other criteria.
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.
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.
Name fields associated with the profile.
Show child attributes
Default Locale for the profile.
Shows 'Complete' if the record is processed, otherwise 'Pending Update.' Read-only.
An optional parameter used when deactivating a profile to specify the reason for deactivation.
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.
Show child attributes
A collection of mailing addresses associated with the profile. The address collection can also include any preferences and consents associated with it.
Show child attributes
A collection of email addresses associated with the profile. The email collection can also include any preferences and consents associated with it.
Show child attributes
A collection of phone numbers associated with the profile. The phone number collection can also include any preferences and consents associated with it.
Show child attributes
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.
Show child attributes
A collection of consents associated with the profile.
Show child attributes
A collection of custom fields associated with the profile.
Show child attributes
A collection of Groups associated with the profile.
Show child attributes
A collection of Tags associated with the profile.
Show child attributes
What made this section unhelpful for you?
Response
[
{
"ProfileId": 27178,
"IsActive": true,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"RegistrationConfirmed": true,
"CustomerType": "Lead",
"PreserveConsents": true,
"PreservePreferences": true,
"CustomerName": {
"FirstName": "John",
"MiddleName": "F",
"LastName": "Doe",
"Prefix": "Mr",
"Suffix": "Jr"
},
"DefaultLocale": "en_US",
"UpdateStatus": "Complete",
"ReasonCode": "",
"AlternateIds": [
{
"AlternateIdType": "Salesforce ContactId",
"AlternateId": "0031njkASSIs2kk909",
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
}
}
],
"Addresses": [
{
"Address1": "4400 River Green Parkway",
"Address2": "Suite 100",
"City": "Duluth",
"StateProvince": "GA",
"CountryCode_Numeric": "840",
"CountryCode_Alpha2": "US",
"CountryCode_Alpha3": "USA",
"PostalCode": "30096-2549",
"AddressType": "Work",
"IsActive": true,
"IsDefault": false,
"CassAddress1": "4400 RIVER GREEN PKWY",
"CassAddress2": "",
"CassCity": "DULUTH",
"CassStateProvince": "GA",
"CassPostalCode": "30096-2531",
"CassStatus": "Y",
"Country": "United States of America",
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"MissingRequiredConsents": false,
"Consents": [
{
"ConsentType": "Direct Mail Consent",
"ConsentVersion": "v1.0",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2024-10-25T13:50:40.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Lead Gen Form - 221",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
]
}
],
"AddressPreferences": [
{
"ProgramId": "in_banking_alert",
"ChannelId": "Mail",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-09-14T20:18:56.943Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_mail",
"PreferenceType": "2",
"FrequencyId": "MONTHLY",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2022-05-03T20:21:48.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": false,
"ConsentAssociations": [
{
"ConsentType": "Opt-in Consent",
"ConsentVersion": "v1",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
]
}
],
"Emails": [
{
"EmailAddressType": "Primary",
"EmailAddress": "john.doe@example.com",
"IsDefault": false,
"Consents": [
{
"ConsentType": "Global Email Marketing Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:50:40.000Z",
"ExpirationDate": "2022-10-25T13:50:40.000Z",
"Expired": true,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"EmailPreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Email",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2023-01-09T14:26:45.280Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_email",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "Nurture-11"
}
],
"CustomerDate": "2023-01-09T14:26:41.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": false,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
}
}
],
"PhoneNumbers": [
{
"PhoneType": "Home",
"PhoneNumber": "7702551021",
"PhoneNumberNumeric": 7702551021,
"IsDefault": false,
"Consents": [
{
"ConsentType": "TCPA Landline Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2023-11-02T21:23:31.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Service App",
"UpdatedVersionPending": false,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T21:23:37.023Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Agent ID - 1334"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"IsMobile": false,
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2024-02-10T13:48:18.943Z",
"ModifiedBy": "My Accounts Page"
},
"PhonePreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Phone",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-02-10T13:48:18.943Z",
"UserId": "App_Preferences_Widget_SC22",
"SourceId": "In-app Widgets",
"FilterId": "fin_banking_phone",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2024-02-10T13:48:13.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false
}
],
"ProfilePreferences": [
{
"ProgramId": "ins_payment_confirmation",
"ChannelId": "Solicit",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2021-11-17T18:44:21.707Z",
"UserId": "My Accounts Page",
"SourceId": "Default",
"FilterId": "ins_payment_app_notify",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "App Id",
"Value": "JADKYK13343KD"
}
],
"CustomerDate": "2023-11-17T18:44:12.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"Consents": [
{
"ConsentType": "CCPA Privacy Rights",
"ConsentVersion": "v4",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:28:49.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2021-11-16T20:42:08.633Z",
"CreatedBy": "Web App",
"ModifiedDate": "2022-10-25T13:28:51.343Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "CA-USA"
}
]
}
],
"CustomFields": [
{
"Name": "Interests",
"Value": "Shopping::Camping and Outdoors::Online Gaming",
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"Groups": [
{
"GroupType": "Household",
"GroupName": "Family",
"IsPrimary": true,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T15:29:15.973Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"ProfileTags": [
{
"Name": "Frequent Customer"
}
]
}
]What made this section unhelpful for you?
Retrieve profiles by address
This method returns one or more profiles that have an exact match on the mailing address field values specified in the request. Passing minimal data in the parameters may result in multiple profiles being returned.
This method can only return up to 50 profiles. If more than 50 matching profiles are found, the API returns a 403-Forbidden. The response will include all active consents, custom fields, groups, tags, and preferences for which you have appropriate permissions.
To increase the likelihood of finding the desired profile, it is recommended to include all available address fields as query parameters. All fields passed in the request must match the corresponding values in the profile for the record to be returned. For example, if you are looking for a profile with the name Audrey Julia Michaels at an unknown address on a street named Jefferson Drive in Roswell, GA, use the request as shown below
GET {clientId}/Profile/Address?address1=Jefferson Drive&city=Roswell&stateProvince=GA&addressType=Home&firstName=Audrey&middleName=Julia&lastName=Michaels&partialAddress1Match=true&partialNameMatch=trueHeader Parameters
Authorization token
Query Parameters
First line of the mailing address in the profile being searched on.
Second line of the mailing address in the profile being searched on.
City, Town, or Village of the mailing address in the profile being searched on.
Province state or district identified in the profile being searched on.
The postal or zip code identified in the address in the profile being searched on.
This is to filter the results on a specific 'Address type' as defined under 'Contact Types' in MyPreferences. As an example this may include home, business, store, or PO Box addresses.
First name of the person whose profile is being searched on.
Middle name of the person whose profile is being searched on.
Last name of the person whose profile is being searched on.
A boolean property when set to true will match on partial address1 field values (Not address 2) For example: When this property is set to true and the user passes in 'Camden', the results will match on '12 Camden Lane' or '134 Camdenisk Way', but not 'Cameron' or '1453 Camdin Rd'. Defaults to false.
A boolean property when set to true will match on partial name fields (firstName, MiddleName, lastName). For example: When this property is set to true and the user passes in a first name of 'Bill' and last name of 'Day', the results will match 'Bill Dayton' or 'Billy Day', but not 'Will Day' or 'Bill David'. Defaults to false.
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 outpu...
Boolean flag, when set to true returns both active and inactive profiles. If not included, the value will default to false.
Optional parameter that, when set to true, returns consent history. When set to false, it returns only the latest consent information. Defaults to true.
Path Parameters
This is your organization’s MyPreferences account Id.
Response
Response Attributes
System-generated unique identifier associated with the profile. Read-only.
Defines whether the item is active or inactive.
Read-only system fields returned as part of an API response. These are updated automatically when a profile is created or modified.
Show child attributes
An optional field for clients to use at their discretion to accommodate scenarios in which customer profile verification is performed.
An identifier used to classify a person based on specific criteria. For example, it can represent their buying stage (prospect, lead, customer), firmographics (industry, company size), or any other criteria.
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.
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.
Name fields associated with the profile.
Show child attributes
Default Locale for the profile.
Shows 'Complete' if the record is processed, otherwise 'Pending Update.' Read-only.
An optional parameter used when deactivating a profile to specify the reason for deactivation.
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.
Show child attributes
A collection of mailing addresses associated with the profile. The address collection can also include any preferences and consents associated with it.
Show child attributes
A collection of email addresses associated with the profile. The email collection can also include any preferences and consents associated with it.
Show child attributes
A collection of phone numbers associated with the profile. The phone number collection can also include any preferences and consents associated with it.
Show child attributes
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.
Show child attributes
A collection of consents associated with the profile.
Show child attributes
A collection of custom fields associated with the profile.
Show child attributes
A collection of Groups associated with the profile.
Show child attributes
A collection of Tags associated with the profile.
Show child attributes
What made this section unhelpful for you?
Response
[
{
"ProfileId": 27178,
"IsActive": true,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"RegistrationConfirmed": true,
"CustomerType": "Lead",
"PreserveConsents": true,
"PreservePreferences": true,
"CustomerName": {
"FirstName": "John",
"MiddleName": "F",
"LastName": "Doe",
"Prefix": "Mr",
"Suffix": "Jr"
},
"DefaultLocale": "en_US",
"UpdateStatus": "Complete",
"ReasonCode": "",
"AlternateIds": [
{
"AlternateIdType": "Salesforce ContactId",
"AlternateId": "0031njkASSIs2kk909",
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
}
}
],
"Addresses": [
{
"Address1": "4400 River Green Parkway",
"Address2": "Suite 100",
"City": "Duluth",
"StateProvince": "GA",
"CountryCode_Numeric": "840",
"CountryCode_Alpha2": "US",
"CountryCode_Alpha3": "USA",
"PostalCode": "30096-2549",
"AddressType": "Work",
"IsActive": true,
"IsDefault": false,
"CassAddress1": "4400 RIVER GREEN PKWY",
"CassAddress2": "",
"CassCity": "DULUTH",
"CassStateProvince": "GA",
"CassPostalCode": "30096-2531",
"CassStatus": "Y",
"Country": "United States of America",
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"MissingRequiredConsents": false,
"Consents": [
{
"ConsentType": "Direct Mail Consent",
"ConsentVersion": "v1.0",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2024-10-25T13:50:40.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Lead Gen Form - 221",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
]
}
],
"AddressPreferences": [
{
"ProgramId": "in_banking_alert",
"ChannelId": "Mail",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-09-14T20:18:56.943Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_mail",
"PreferenceType": "2",
"FrequencyId": "MONTHLY",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2022-05-03T20:21:48.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": false,
"ConsentAssociations": [
{
"ConsentType": "Opt-in Consent",
"ConsentVersion": "v1",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
]
}
],
"Emails": [
{
"EmailAddressType": "Primary",
"EmailAddress": "john.doe@example.com",
"IsDefault": false,
"Consents": [
{
"ConsentType": "Global Email Marketing Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:50:40.000Z",
"ExpirationDate": "2022-10-25T13:50:40.000Z",
"Expired": true,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"EmailPreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Email",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2023-01-09T14:26:45.280Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_email",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "Nurture-11"
}
],
"CustomerDate": "2023-01-09T14:26:41.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": false,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
}
}
],
"PhoneNumbers": [
{
"PhoneType": "Home",
"PhoneNumber": "7702551021",
"PhoneNumberNumeric": 7702551021,
"IsDefault": false,
"Consents": [
{
"ConsentType": "TCPA Landline Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2023-11-02T21:23:31.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Service App",
"UpdatedVersionPending": false,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T21:23:37.023Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Agent ID - 1334"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"IsMobile": false,
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2024-02-10T13:48:18.943Z",
"ModifiedBy": "My Accounts Page"
},
"PhonePreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Phone",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-02-10T13:48:18.943Z",
"UserId": "App_Preferences_Widget_SC22",
"SourceId": "In-app Widgets",
"FilterId": "fin_banking_phone",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2024-02-10T13:48:13.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false
}
],
"ProfilePreferences": [
{
"ProgramId": "ins_payment_confirmation",
"ChannelId": "Solicit",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2021-11-17T18:44:21.707Z",
"UserId": "My Accounts Page",
"SourceId": "Default",
"FilterId": "ins_payment_app_notify",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "App Id",
"Value": "JADKYK13343KD"
}
],
"CustomerDate": "2023-11-17T18:44:12.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"Consents": [
{
"ConsentType": "CCPA Privacy Rights",
"ConsentVersion": "v4",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:28:49.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2021-11-16T20:42:08.633Z",
"CreatedBy": "Web App",
"ModifiedDate": "2022-10-25T13:28:51.343Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "CA-USA"
}
]
}
],
"CustomFields": [
{
"Name": "Interests",
"Value": "Shopping::Camping and Outdoors::Online Gaming",
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"Groups": [
{
"GroupType": "Household",
"GroupName": "Family",
"IsPrimary": true,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T15:29:15.973Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"ProfileTags": [
{
"Name": "Frequent Customer"
}
]
}
]What made this section unhelpful for you?
Retrieve profiles by name
This method will retrieve one or more profiles that have an exact match on the firstName, middleName and lastName values specified in the request.
This method can only return up to 50 profiles. If more than 50 matching profiles are found, the API returns a 403-Forbidden.
The response will include all active consents, custom fields, groups, tags, and preferences for which you have appropriate permissions.
Header Parameters
Authorization token
Query Parameters
Last name used to retrieve the matching profile(s).
First name used to retrieve the matching profile(s).
Middle name used to retrieve the matching profile(s).
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 outpu...
Boolean flag, when set to true returns both active and inactive profiles. If not included, the value will default to false.
Optional parameter that, when set to true, returns consent history. When set to false, it returns only the latest consent information. Defaults to true.
Path Parameters
This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.
Response
Response Attributes
System-generated unique identifier associated with the profile. Read-only.
Defines whether the item is active or inactive.
Read-only system fields returned as part of an API response. These are updated automatically when a profile is created or modified.
Show child attributes
An optional field for clients to use at their discretion to accommodate scenarios in which customer profile verification is performed.
An identifier used to classify a person based on specific criteria. For example, it can represent their buying stage (prospect, lead, customer), firmographics (industry, company size), or any other criteria.
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.
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.
Name fields associated with the profile.
Show child attributes
Default Locale for the profile.
Shows 'Complete' if the record is processed, otherwise 'Pending Update.' Read-only.
An optional parameter used when deactivating a profile to specify the reason for deactivation.
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.
Show child attributes
A collection of mailing addresses associated with the profile. The address collection can also include any preferences and consents associated with it.
Show child attributes
A collection of email addresses associated with the profile. The email collection can also include any preferences and consents associated with it.
Show child attributes
A collection of phone numbers associated with the profile. The phone number collection can also include any preferences and consents associated with it.
Show child attributes
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.
Show child attributes
A collection of consents associated with the profile.
Show child attributes
A collection of custom fields associated with the profile.
Show child attributes
A collection of Groups associated with the profile.
Show child attributes
A collection of Tags associated with the profile.
Show child attributes
What made this section unhelpful for you?
Response
[
{
"ProfileId": 27178,
"IsActive": true,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"RegistrationConfirmed": true,
"CustomerType": "Lead",
"PreserveConsents": true,
"PreservePreferences": true,
"CustomerName": {
"FirstName": "John",
"MiddleName": "F",
"LastName": "Doe",
"Prefix": "Mr",
"Suffix": "Jr"
},
"DefaultLocale": "en_US",
"UpdateStatus": "Complete",
"ReasonCode": "",
"AlternateIds": [
{
"AlternateIdType": "Salesforce ContactId",
"AlternateId": "0031njkASSIs2kk909",
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
}
}
],
"Addresses": [
{
"Address1": "4400 River Green Parkway",
"Address2": "Suite 100",
"City": "Duluth",
"StateProvince": "GA",
"CountryCode_Numeric": "840",
"CountryCode_Alpha2": "US",
"CountryCode_Alpha3": "USA",
"PostalCode": "30096-2549",
"AddressType": "Work",
"IsActive": true,
"IsDefault": false,
"CassAddress1": "4400 RIVER GREEN PKWY",
"CassAddress2": "",
"CassCity": "DULUTH",
"CassStateProvince": "GA",
"CassPostalCode": "30096-2531",
"CassStatus": "Y",
"Country": "United States of America",
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"MissingRequiredConsents": false,
"Consents": [
{
"ConsentType": "Direct Mail Consent",
"ConsentVersion": "v1.0",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2024-10-25T13:50:40.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Lead Gen Form - 221",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
]
}
],
"AddressPreferences": [
{
"ProgramId": "in_banking_alert",
"ChannelId": "Mail",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-09-14T20:18:56.943Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_mail",
"PreferenceType": "2",
"FrequencyId": "MONTHLY",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2022-05-03T20:21:48.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": false,
"ConsentAssociations": [
{
"ConsentType": "Opt-in Consent",
"ConsentVersion": "v1",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
]
}
],
"Emails": [
{
"EmailAddressType": "Primary",
"EmailAddress": "john.doe@example.com",
"IsDefault": false,
"Consents": [
{
"ConsentType": "Global Email Marketing Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:50:40.000Z",
"ExpirationDate": "2022-10-25T13:50:40.000Z",
"Expired": true,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"EmailPreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Email",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2023-01-09T14:26:45.280Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_email",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "Nurture-11"
}
],
"CustomerDate": "2023-01-09T14:26:41.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": false,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
}
}
],
"PhoneNumbers": [
{
"PhoneType": "Home",
"PhoneNumber": "7702551021",
"PhoneNumberNumeric": 7702551021,
"IsDefault": false,
"Consents": [
{
"ConsentType": "TCPA Landline Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2023-11-02T21:23:31.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Service App",
"UpdatedVersionPending": false,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T21:23:37.023Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Agent ID - 1334"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"IsMobile": false,
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2024-02-10T13:48:18.943Z",
"ModifiedBy": "My Accounts Page"
},
"PhonePreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Phone",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-02-10T13:48:18.943Z",
"UserId": "App_Preferences_Widget_SC22",
"SourceId": "In-app Widgets",
"FilterId": "fin_banking_phone",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2024-02-10T13:48:13.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false
}
],
"ProfilePreferences": [
{
"ProgramId": "ins_payment_confirmation",
"ChannelId": "Solicit",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2021-11-17T18:44:21.707Z",
"UserId": "My Accounts Page",
"SourceId": "Default",
"FilterId": "ins_payment_app_notify",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "App Id",
"Value": "JADKYK13343KD"
}
],
"CustomerDate": "2023-11-17T18:44:12.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"Consents": [
{
"ConsentType": "CCPA Privacy Rights",
"ConsentVersion": "v4",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:28:49.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2021-11-16T20:42:08.633Z",
"CreatedBy": "Web App",
"ModifiedDate": "2022-10-25T13:28:51.343Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "CA-USA"
}
]
}
],
"CustomFields": [
{
"Name": "Interests",
"Value": "Shopping::Camping and Outdoors::Online Gaming",
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"Groups": [
{
"GroupType": "Household",
"GroupName": "Family",
"IsPrimary": true,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T15:29:15.973Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"ProfileTags": [
{
"Name": "Frequent Customer"
}
]
}
]What made this section unhelpful for you?
Retrieve profiles by partial name
This method will retrieve one or more profiles that have a partial match on the firstName, middleName, and lastName values specified in the request.
This method can only return up to 50 profiles. If more than 50 matching profiles are found, the API returns a 403-Forbidden.
The response will include all active consents, custom fields, groups, tags, and preferences for which you have appropriate permissions.
For example, suppose we specify the lastName parameter as 'Smi'. In this case, the matching process will look for last names that contain the substring 'Smi'. As a result, last names like 'Smith' or 'Smilla' would be considered as matches because they contain the substring 'Smi'. However, last names such as 'Small' or 'Sampson' would not be considered as matches because they do not contain the exact substring 'Smi'.
Header Parameters
Authorization token
Query Parameters
Last name used to retrieve the matching profile(s).
First name used to retrieve the matching profile(s).
Middle name used to retrieve the matching profile(s).
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 outpu...
Boolean flag, when set to true returns both active and inactive profiles. If not included, the value will default to false.
Optional parameter that, when set to true, returns consent history. When set to false, it returns only the latest consent information. Defaults to true.
Path Parameters
This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.
Response
Response Attributes
System-generated unique identifier associated with the profile. Read-only.
Defines whether the item is active or inactive.
Read-only system fields returned as part of an API response. These are updated automatically when a profile is created or modified.
Show child attributes
An optional field for clients to use at their discretion to accommodate scenarios in which customer profile verification is performed.
An identifier used to classify a person based on specific criteria. For example, it can represent their buying stage (prospect, lead, customer), firmographics (industry, company size), or any other criteria.
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.
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.
Name fields associated with the profile.
Show child attributes
Default Locale for the profile.
Shows 'Complete' if the record is processed, otherwise 'Pending Update.' Read-only.
An optional parameter used when deactivating a profile to specify the reason for deactivation.
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.
Show child attributes
A collection of mailing addresses associated with the profile. The address collection can also include any preferences and consents associated with it.
Show child attributes
A collection of email addresses associated with the profile. The email collection can also include any preferences and consents associated with it.
Show child attributes
A collection of phone numbers associated with the profile. The phone number collection can also include any preferences and consents associated with it.
Show child attributes
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.
Show child attributes
A collection of consents associated with the profile.
Show child attributes
A collection of custom fields associated with the profile.
Show child attributes
A collection of Groups associated with the profile.
Show child attributes
A collection of Tags associated with the profile.
Show child attributes
What made this section unhelpful for you?
Response
[
{
"ProfileId": 27178,
"IsActive": true,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"RegistrationConfirmed": true,
"CustomerType": "Lead",
"PreserveConsents": true,
"PreservePreferences": true,
"CustomerName": {
"FirstName": "John",
"MiddleName": "F",
"LastName": "Doe",
"Prefix": "Mr",
"Suffix": "Jr"
},
"DefaultLocale": "en_US",
"UpdateStatus": "Complete",
"ReasonCode": "",
"AlternateIds": [
{
"AlternateIdType": "Salesforce ContactId",
"AlternateId": "0031njkASSIs2kk909",
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
}
}
],
"Addresses": [
{
"Address1": "4400 River Green Parkway",
"Address2": "Suite 100",
"City": "Duluth",
"StateProvince": "GA",
"CountryCode_Numeric": "840",
"CountryCode_Alpha2": "US",
"CountryCode_Alpha3": "USA",
"PostalCode": "30096-2549",
"AddressType": "Work",
"IsActive": true,
"IsDefault": false,
"CassAddress1": "4400 RIVER GREEN PKWY",
"CassAddress2": "",
"CassCity": "DULUTH",
"CassStateProvince": "GA",
"CassPostalCode": "30096-2531",
"CassStatus": "Y",
"Country": "United States of America",
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"MissingRequiredConsents": false,
"Consents": [
{
"ConsentType": "Direct Mail Consent",
"ConsentVersion": "v1.0",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2024-10-25T13:50:40.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Lead Gen Form - 221",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
]
}
],
"AddressPreferences": [
{
"ProgramId": "in_banking_alert",
"ChannelId": "Mail",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-09-14T20:18:56.943Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_mail",
"PreferenceType": "2",
"FrequencyId": "MONTHLY",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2022-05-03T20:21:48.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": false,
"ConsentAssociations": [
{
"ConsentType": "Opt-in Consent",
"ConsentVersion": "v1",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
]
}
],
"Emails": [
{
"EmailAddressType": "Primary",
"EmailAddress": "john.doe@example.com",
"IsDefault": false,
"Consents": [
{
"ConsentType": "Global Email Marketing Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:50:40.000Z",
"ExpirationDate": "2022-10-25T13:50:40.000Z",
"Expired": true,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"EmailPreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Email",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2023-01-09T14:26:45.280Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_email",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "Nurture-11"
}
],
"CustomerDate": "2023-01-09T14:26:41.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": false,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
}
}
],
"PhoneNumbers": [
{
"PhoneType": "Home",
"PhoneNumber": "7702551021",
"PhoneNumberNumeric": 7702551021,
"IsDefault": false,
"Consents": [
{
"ConsentType": "TCPA Landline Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2023-11-02T21:23:31.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Service App",
"UpdatedVersionPending": false,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T21:23:37.023Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Agent ID - 1334"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"IsMobile": false,
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2024-02-10T13:48:18.943Z",
"ModifiedBy": "My Accounts Page"
},
"PhonePreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Phone",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-02-10T13:48:18.943Z",
"UserId": "App_Preferences_Widget_SC22",
"SourceId": "In-app Widgets",
"FilterId": "fin_banking_phone",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2024-02-10T13:48:13.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false
}
],
"ProfilePreferences": [
{
"ProgramId": "ins_payment_confirmation",
"ChannelId": "Solicit",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2021-11-17T18:44:21.707Z",
"UserId": "My Accounts Page",
"SourceId": "Default",
"FilterId": "ins_payment_app_notify",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "App Id",
"Value": "JADKYK13343KD"
}
],
"CustomerDate": "2023-11-17T18:44:12.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"Consents": [
{
"ConsentType": "CCPA Privacy Rights",
"ConsentVersion": "v4",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:28:49.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2021-11-16T20:42:08.633Z",
"CreatedBy": "Web App",
"ModifiedDate": "2022-10-25T13:28:51.343Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "CA-USA"
}
]
}
],
"CustomFields": [
{
"Name": "Interests",
"Value": "Shopping::Camping and Outdoors::Online Gaming",
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"Groups": [
{
"GroupType": "Household",
"GroupName": "Family",
"IsPrimary": true,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T15:29:15.973Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"ProfileTags": [
{
"Name": "Frequent Customer"
}
]
}
]What made this section unhelpful for you?
Retrieve profiles by custom fields
This method returns one or more profiles that meet the custom field criteria specified in the query string. It supports filtering on multiple custom fields, and the parameters are passed as an array. The first field and value combination start with index 0.
This method can only return up to 50 profiles. If more than 50 matching profiles are found, the API returns a 403-Forbidden.
All active consents, custom fields, groups, tags, and preferences for which you have permissions will be returned in the response.
For example, if you are searching for a profile with the custom field "alpha" having a value of "couch" and the custom field "beta" having a value of "book," use the following request.
GET {clientId}/Profile/CustomFields?customFields[0].Name=alpha&customFields[0].Value=couch&customFields[1].Name=beta&customFields[1].Value=book Header Parameters
Authorization token
Query Parameters
Optional parameter that, when set to true, returns consent history. When set to false, it returns only the latest consent information. Defaults to true.
Path Parameters
This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.
Response
Response Attributes
System-generated unique identifier associated with the profile. Read-only.
Defines whether the item is active or inactive.
Read-only system fields returned as part of an API response. These are updated automatically when a profile is created or modified.
Show child attributes
An optional field for clients to use at their discretion to accommodate scenarios in which customer profile verification is performed.
An identifier used to classify a person based on specific criteria. For example, it can represent their buying stage (prospect, lead, customer), firmographics (industry, company size), or any other criteria.
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.
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.
Name fields associated with the profile.
Show child attributes
Default Locale for the profile.
Shows 'Complete' if the record is processed, otherwise 'Pending Update.' Read-only.
An optional parameter used when deactivating a profile to specify the reason for deactivation.
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.
Show child attributes
A collection of mailing addresses associated with the profile. The address collection can also include any preferences and consents associated with it.
Show child attributes
A collection of email addresses associated with the profile. The email collection can also include any preferences and consents associated with it.
Show child attributes
A collection of phone numbers associated with the profile. The phone number collection can also include any preferences and consents associated with it.
Show child attributes
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.
Show child attributes
A collection of consents associated with the profile.
Show child attributes
A collection of custom fields associated with the profile.
Show child attributes
A collection of Groups associated with the profile.
Show child attributes
A collection of Tags associated with the profile.
Show child attributes
What made this section unhelpful for you?
Response
[
{
"ProfileId": 27178,
"IsActive": true,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"RegistrationConfirmed": true,
"CustomerType": "Lead",
"PreserveConsents": true,
"PreservePreferences": true,
"CustomerName": {
"FirstName": "John",
"MiddleName": "F",
"LastName": "Doe",
"Prefix": "Mr",
"Suffix": "Jr"
},
"DefaultLocale": "en_US",
"UpdateStatus": "Complete",
"ReasonCode": "",
"AlternateIds": [
{
"AlternateIdType": "Salesforce ContactId",
"AlternateId": "0031njkASSIs2kk909",
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
}
}
],
"Addresses": [
{
"Address1": "4400 River Green Parkway",
"Address2": "Suite 100",
"City": "Duluth",
"StateProvince": "GA",
"CountryCode_Numeric": "840",
"CountryCode_Alpha2": "US",
"CountryCode_Alpha3": "USA",
"PostalCode": "30096-2549",
"AddressType": "Work",
"IsActive": true,
"IsDefault": false,
"CassAddress1": "4400 RIVER GREEN PKWY",
"CassAddress2": "",
"CassCity": "DULUTH",
"CassStateProvince": "GA",
"CassPostalCode": "30096-2531",
"CassStatus": "Y",
"Country": "United States of America",
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"MissingRequiredConsents": false,
"Consents": [
{
"ConsentType": "Direct Mail Consent",
"ConsentVersion": "v1.0",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2024-10-25T13:50:40.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Lead Gen Form - 221",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
]
}
],
"AddressPreferences": [
{
"ProgramId": "in_banking_alert",
"ChannelId": "Mail",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-09-14T20:18:56.943Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_mail",
"PreferenceType": "2",
"FrequencyId": "MONTHLY",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2022-05-03T20:21:48.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": false,
"ConsentAssociations": [
{
"ConsentType": "Opt-in Consent",
"ConsentVersion": "v1",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
]
}
],
"Emails": [
{
"EmailAddressType": "Primary",
"EmailAddress": "john.doe@example.com",
"IsDefault": false,
"Consents": [
{
"ConsentType": "Global Email Marketing Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:50:40.000Z",
"ExpirationDate": "2022-10-25T13:50:40.000Z",
"Expired": true,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"EmailPreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Email",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2023-01-09T14:26:45.280Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_email",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "Nurture-11"
}
],
"CustomerDate": "2023-01-09T14:26:41.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": false,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
}
}
],
"PhoneNumbers": [
{
"PhoneType": "Home",
"PhoneNumber": "7702551021",
"PhoneNumberNumeric": 7702551021,
"IsDefault": false,
"Consents": [
{
"ConsentType": "TCPA Landline Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2023-11-02T21:23:31.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Service App",
"UpdatedVersionPending": false,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T21:23:37.023Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Agent ID - 1334"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"IsMobile": false,
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2024-02-10T13:48:18.943Z",
"ModifiedBy": "My Accounts Page"
},
"PhonePreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Phone",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-02-10T13:48:18.943Z",
"UserId": "App_Preferences_Widget_SC22",
"SourceId": "In-app Widgets",
"FilterId": "fin_banking_phone",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2024-02-10T13:48:13.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false
}
],
"ProfilePreferences": [
{
"ProgramId": "ins_payment_confirmation",
"ChannelId": "Solicit",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2021-11-17T18:44:21.707Z",
"UserId": "My Accounts Page",
"SourceId": "Default",
"FilterId": "ins_payment_app_notify",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "App Id",
"Value": "JADKYK13343KD"
}
],
"CustomerDate": "2023-11-17T18:44:12.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"Consents": [
{
"ConsentType": "CCPA Privacy Rights",
"ConsentVersion": "v4",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:28:49.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2021-11-16T20:42:08.633Z",
"CreatedBy": "Web App",
"ModifiedDate": "2022-10-25T13:28:51.343Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "CA-USA"
}
]
}
],
"CustomFields": [
{
"Name": "Interests",
"Value": "Shopping::Camping and Outdoors::Online Gaming",
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"Groups": [
{
"GroupType": "Household",
"GroupName": "Family",
"IsPrimary": true,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T15:29:15.973Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"ProfileTags": [
{
"Name": "Frequent Customer"
}
]
}
]What made this section unhelpful for you?
Retrieve profiles by SelectList custom fields
This method enhances the capability to search for profiles based on custom fields by incorporating operators for each custom field. These operators, which includes, Equals, All of, or Any of, allow for greater flexibility in filtering the customFields.Value parameter and evaluating its values.
This method can only return up to 50 profiles. If more than 50 matching profiles are found, the API returns a 403-Forbidden.
The response will include all active consents, custom fields, groups, tags, and preferences for which you have appropriate permissions.
For example: if you are looking for a profile with a custom field "alpha" with any of the values "couch, chair or table" use the following request:
GET {clientId}/Profile/CustomFields/SelectList? customFields[0].OperatorId=3&customFields[0].Name=alpha&customFields[0].Value=couch:chair:table Header Parameters
Authorization token
Query Parameters
Optional parameter that, when set to true, returns consent history. When set to false, it returns only the latest consent information. Defaults to true.
Path Parameters
This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.
Response
Response Attributes
System-generated unique identifier associated with the profile. Read-only.
Defines whether the item is active or inactive.
Read-only system fields returned as part of an API response. These are updated automatically when a profile is created or modified.
Show child attributes
An optional field for clients to use at their discretion to accommodate scenarios in which customer profile verification is performed.
An identifier used to classify a person based on specific criteria. For example, it can represent their buying stage (prospect, lead, customer), firmographics (industry, company size), or any other criteria.
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.
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.
Name fields associated with the profile.
Show child attributes
Default Locale for the profile.
Shows 'Complete' if the record is processed, otherwise 'Pending Update.' Read-only.
An optional parameter used when deactivating a profile to specify the reason for deactivation.
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.
Show child attributes
A collection of mailing addresses associated with the profile. The address collection can also include any preferences and consents associated with it.
Show child attributes
A collection of email addresses associated with the profile. The email collection can also include any preferences and consents associated with it.
Show child attributes
A collection of phone numbers associated with the profile. The phone number collection can also include any preferences and consents associated with it.
Show child attributes
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.
Show child attributes
A collection of consents associated with the profile.
Show child attributes
A collection of custom fields associated with the profile.
Show child attributes
A collection of Groups associated with the profile.
Show child attributes
A collection of Tags associated with the profile.
Show child attributes
What made this section unhelpful for you?
Response
[
{
"ProfileId": 27178,
"IsActive": true,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"RegistrationConfirmed": true,
"CustomerType": "Lead",
"PreserveConsents": true,
"PreservePreferences": true,
"CustomerName": {
"FirstName": "John",
"MiddleName": "F",
"LastName": "Doe",
"Prefix": "Mr",
"Suffix": "Jr"
},
"DefaultLocale": "en_US",
"UpdateStatus": "Complete",
"ReasonCode": "",
"AlternateIds": [
{
"AlternateIdType": "Salesforce ContactId",
"AlternateId": "0031njkASSIs2kk909",
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
}
}
],
"Addresses": [
{
"Address1": "4400 River Green Parkway",
"Address2": "Suite 100",
"City": "Duluth",
"StateProvince": "GA",
"CountryCode_Numeric": "840",
"CountryCode_Alpha2": "US",
"CountryCode_Alpha3": "USA",
"PostalCode": "30096-2549",
"AddressType": "Work",
"IsActive": true,
"IsDefault": false,
"CassAddress1": "4400 RIVER GREEN PKWY",
"CassAddress2": "",
"CassCity": "DULUTH",
"CassStateProvince": "GA",
"CassPostalCode": "30096-2531",
"CassStatus": "Y",
"Country": "United States of America",
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"MissingRequiredConsents": false,
"Consents": [
{
"ConsentType": "Direct Mail Consent",
"ConsentVersion": "v1.0",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2024-10-25T13:50:40.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Lead Gen Form - 221",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
]
}
],
"AddressPreferences": [
{
"ProgramId": "in_banking_alert",
"ChannelId": "Mail",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-09-14T20:18:56.943Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_mail",
"PreferenceType": "2",
"FrequencyId": "MONTHLY",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2022-05-03T20:21:48.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": false,
"ConsentAssociations": [
{
"ConsentType": "Opt-in Consent",
"ConsentVersion": "v1",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
]
}
],
"Emails": [
{
"EmailAddressType": "Primary",
"EmailAddress": "john.doe@example.com",
"IsDefault": false,
"Consents": [
{
"ConsentType": "Global Email Marketing Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:50:40.000Z",
"ExpirationDate": "2022-10-25T13:50:40.000Z",
"Expired": true,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"EmailPreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Email",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2023-01-09T14:26:45.280Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_email",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "Nurture-11"
}
],
"CustomerDate": "2023-01-09T14:26:41.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": false,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
}
}
],
"PhoneNumbers": [
{
"PhoneType": "Home",
"PhoneNumber": "7702551021",
"PhoneNumberNumeric": 7702551021,
"IsDefault": false,
"Consents": [
{
"ConsentType": "TCPA Landline Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2023-11-02T21:23:31.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Service App",
"UpdatedVersionPending": false,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T21:23:37.023Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Agent ID - 1334"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"IsMobile": false,
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2024-02-10T13:48:18.943Z",
"ModifiedBy": "My Accounts Page"
},
"PhonePreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Phone",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-02-10T13:48:18.943Z",
"UserId": "App_Preferences_Widget_SC22",
"SourceId": "In-app Widgets",
"FilterId": "fin_banking_phone",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2024-02-10T13:48:13.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false
}
],
"ProfilePreferences": [
{
"ProgramId": "ins_payment_confirmation",
"ChannelId": "Solicit",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2021-11-17T18:44:21.707Z",
"UserId": "My Accounts Page",
"SourceId": "Default",
"FilterId": "ins_payment_app_notify",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "App Id",
"Value": "JADKYK13343KD"
}
],
"CustomerDate": "2023-11-17T18:44:12.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"Consents": [
{
"ConsentType": "CCPA Privacy Rights",
"ConsentVersion": "v4",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:28:49.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2021-11-16T20:42:08.633Z",
"CreatedBy": "Web App",
"ModifiedDate": "2022-10-25T13:28:51.343Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "CA-USA"
}
]
}
],
"CustomFields": [
{
"Name": "Interests",
"Value": "Shopping::Camping and Outdoors::Online Gaming",
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"Groups": [
{
"GroupType": "Household",
"GroupName": "Family",
"IsPrimary": true,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T15:29:15.973Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"ProfileTags": [
{
"Name": "Frequent Customer"
}
]
}
]What made this section unhelpful for you?
Retrieve profiles by tags
This method allows you to retrieve one or more profiles that match the tag values specified in the request. Tag parameters are read as an array where the first tag value begins with index 0, followed by subsequent values.
This method can only return up to 50 profiles. If more than 50 matching profiles are found, the API returns a 403-Forbidden.
The response will include all active consents, custom fields, groups, tags, and preferences for which you have appropriate permissions.
Header Parameters
Authorization token
Query Parameters
Boolean flag that when set to false, returns profile(s) that match on any of the tags in tagList. When this value is set to true, all of the tags that are in the tagList must match for the profile to be returned. Defaults to true.
Boolean flag that when set to true, returns all profile(s) that match on any of the tags in tagList. Defaults to false.
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 outpu...
Optional parameter that, when set to true, returns consent history. When set to false, it returns only the latest consent information. Defaults to true.
Path Parameters
This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.
Response
Response Attributes
System-generated unique identifier associated with the profile. Read-only.
Defines whether the item is active or inactive.
Read-only system fields returned as part of an API response. These are updated automatically when a profile is created or modified.
Show child attributes
An optional field for clients to use at their discretion to accommodate scenarios in which customer profile verification is performed.
An identifier used to classify a person based on specific criteria. For example, it can represent their buying stage (prospect, lead, customer), firmographics (industry, company size), or any other criteria.
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.
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.
Name fields associated with the profile.
Show child attributes
Default Locale for the profile.
Shows 'Complete' if the record is processed, otherwise 'Pending Update.' Read-only.
An optional parameter used when deactivating a profile to specify the reason for deactivation.
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.
Show child attributes
A collection of mailing addresses associated with the profile. The address collection can also include any preferences and consents associated with it.
Show child attributes
A collection of email addresses associated with the profile. The email collection can also include any preferences and consents associated with it.
Show child attributes
A collection of phone numbers associated with the profile. The phone number collection can also include any preferences and consents associated with it.
Show child attributes
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.
Show child attributes
A collection of consents associated with the profile.
Show child attributes
A collection of custom fields associated with the profile.
Show child attributes
A collection of Groups associated with the profile.
Show child attributes
A collection of Tags associated with the profile.
Show child attributes
What made this section unhelpful for you?
Response
[
{
"ProfileId": 27178,
"IsActive": true,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"RegistrationConfirmed": true,
"CustomerType": "Lead",
"PreserveConsents": true,
"PreservePreferences": true,
"CustomerName": {
"FirstName": "John",
"MiddleName": "F",
"LastName": "Doe",
"Prefix": "Mr",
"Suffix": "Jr"
},
"DefaultLocale": "en_US",
"UpdateStatus": "Complete",
"ReasonCode": "",
"AlternateIds": [
{
"AlternateIdType": "Salesforce ContactId",
"AlternateId": "0031njkASSIs2kk909",
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
}
}
],
"Addresses": [
{
"Address1": "4400 River Green Parkway",
"Address2": "Suite 100",
"City": "Duluth",
"StateProvince": "GA",
"CountryCode_Numeric": "840",
"CountryCode_Alpha2": "US",
"CountryCode_Alpha3": "USA",
"PostalCode": "30096-2549",
"AddressType": "Work",
"IsActive": true,
"IsDefault": false,
"CassAddress1": "4400 RIVER GREEN PKWY",
"CassAddress2": "",
"CassCity": "DULUTH",
"CassStateProvince": "GA",
"CassPostalCode": "30096-2531",
"CassStatus": "Y",
"Country": "United States of America",
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"MissingRequiredConsents": false,
"Consents": [
{
"ConsentType": "Direct Mail Consent",
"ConsentVersion": "v1.0",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2024-10-25T13:50:40.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Lead Gen Form - 221",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
]
}
],
"AddressPreferences": [
{
"ProgramId": "in_banking_alert",
"ChannelId": "Mail",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-09-14T20:18:56.943Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_mail",
"PreferenceType": "2",
"FrequencyId": "MONTHLY",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2022-05-03T20:21:48.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": false,
"ConsentAssociations": [
{
"ConsentType": "Opt-in Consent",
"ConsentVersion": "v1",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
]
}
],
"Emails": [
{
"EmailAddressType": "Primary",
"EmailAddress": "john.doe@example.com",
"IsDefault": false,
"Consents": [
{
"ConsentType": "Global Email Marketing Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:50:40.000Z",
"ExpirationDate": "2022-10-25T13:50:40.000Z",
"Expired": true,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"EmailPreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Email",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2023-01-09T14:26:45.280Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_email",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "Nurture-11"
}
],
"CustomerDate": "2023-01-09T14:26:41.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": false,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
}
}
],
"PhoneNumbers": [
{
"PhoneType": "Home",
"PhoneNumber": "7702551021",
"PhoneNumberNumeric": 7702551021,
"IsDefault": false,
"Consents": [
{
"ConsentType": "TCPA Landline Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2023-11-02T21:23:31.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Service App",
"UpdatedVersionPending": false,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T21:23:37.023Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Agent ID - 1334"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"IsMobile": false,
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2024-02-10T13:48:18.943Z",
"ModifiedBy": "My Accounts Page"
},
"PhonePreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Phone",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-02-10T13:48:18.943Z",
"UserId": "App_Preferences_Widget_SC22",
"SourceId": "In-app Widgets",
"FilterId": "fin_banking_phone",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2024-02-10T13:48:13.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false
}
],
"ProfilePreferences": [
{
"ProgramId": "ins_payment_confirmation",
"ChannelId": "Solicit",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2021-11-17T18:44:21.707Z",
"UserId": "My Accounts Page",
"SourceId": "Default",
"FilterId": "ins_payment_app_notify",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "App Id",
"Value": "JADKYK13343KD"
}
],
"CustomerDate": "2023-11-17T18:44:12.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"Consents": [
{
"ConsentType": "CCPA Privacy Rights",
"ConsentVersion": "v4",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:28:49.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2021-11-16T20:42:08.633Z",
"CreatedBy": "Web App",
"ModifiedDate": "2022-10-25T13:28:51.343Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "CA-USA"
}
]
}
],
"CustomFields": [
{
"Name": "Interests",
"Value": "Shopping::Camping and Outdoors::Online Gaming",
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"Groups": [
{
"GroupType": "Household",
"GroupName": "Family",
"IsPrimary": true,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T15:29:15.973Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"ProfileTags": [
{
"Name": "Frequent Customer"
}
]
}
]What made this section unhelpful for you?
Retrieve profiles by consent attributes
This method returns one or more profiles that meet the consent attribute criteria specified in the query string. It supports filtering on multiple consent attributes, and the parameters are passed as an array. The first key and value combination start with index 0.
This method can only return up to 50 profiles. If more than 50 matching profiles are found, the API returns a 403-Forbidden.
All active consents, custom fields, groups, tags, and preferences for which you have permissions will be returned in the response.
To illustrate, suppose you want to search for a profile with the consent attribute key "alpha" and a value of "couch," as well as another attribute key "beta" with a value of "book." In that case, you can use the following request as an example.
GET {clientId}/Profile/Consent/Attributes?attributes[0].Key=alpha&attributes[0].Value=phone&attributes[1].Key=beta&attributes[1].Value=account Header Parameters
Authorization token
Query Parameters
Optional parameter that, when set to true, returns consent history. When set to false, it returns only the latest consent information. Defaults to true.
Path Parameters
This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.
Response
Response Attributes
System-generated unique identifier associated with the profile. Read-only.
Defines whether the item is active or inactive.
Read-only system fields returned as part of an API response. These are updated automatically when a profile is created or modified.
Show child attributes
An optional field for clients to use at their discretion to accommodate scenarios in which customer profile verification is performed.
An identifier used to classify a person based on specific criteria. For example, it can represent their buying stage (prospect, lead, customer), firmographics (industry, company size), or any other criteria.
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.
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.
Name fields associated with the profile.
Show child attributes
Default Locale for the profile.
Shows 'Complete' if the record is processed, otherwise 'Pending Update.' Read-only.
An optional parameter used when deactivating a profile to specify the reason for deactivation.
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.
Show child attributes
A collection of mailing addresses associated with the profile. The address collection can also include any preferences and consents associated with it.
Show child attributes
A collection of email addresses associated with the profile. The email collection can also include any preferences and consents associated with it.
Show child attributes
A collection of phone numbers associated with the profile. The phone number collection can also include any preferences and consents associated with it.
Show child attributes
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.
Show child attributes
A collection of consents associated with the profile.
Show child attributes
A collection of custom fields associated with the profile.
Show child attributes
A collection of Groups associated with the profile.
Show child attributes
A collection of Tags associated with the profile.
Show child attributes
What made this section unhelpful for you?
Response
[
{
"ProfileId": 27178,
"IsActive": true,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"RegistrationConfirmed": true,
"CustomerType": "Lead",
"PreserveConsents": true,
"PreservePreferences": true,
"CustomerName": {
"FirstName": "John",
"MiddleName": "F",
"LastName": "Doe",
"Prefix": "Mr",
"Suffix": "Jr"
},
"DefaultLocale": "en_US",
"UpdateStatus": "Complete",
"ReasonCode": "",
"AlternateIds": [
{
"AlternateIdType": "Salesforce ContactId",
"AlternateId": "0031njkASSIs2kk909",
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
}
}
],
"Addresses": [
{
"Address1": "4400 River Green Parkway",
"Address2": "Suite 100",
"City": "Duluth",
"StateProvince": "GA",
"CountryCode_Numeric": "840",
"CountryCode_Alpha2": "US",
"CountryCode_Alpha3": "USA",
"PostalCode": "30096-2549",
"AddressType": "Work",
"IsActive": true,
"IsDefault": false,
"CassAddress1": "4400 RIVER GREEN PKWY",
"CassAddress2": "",
"CassCity": "DULUTH",
"CassStateProvince": "GA",
"CassPostalCode": "30096-2531",
"CassStatus": "Y",
"Country": "United States of America",
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"MissingRequiredConsents": false,
"Consents": [
{
"ConsentType": "Direct Mail Consent",
"ConsentVersion": "v1.0",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2024-10-25T13:50:40.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Lead Gen Form - 221",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
]
}
],
"AddressPreferences": [
{
"ProgramId": "in_banking_alert",
"ChannelId": "Mail",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-09-14T20:18:56.943Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_mail",
"PreferenceType": "2",
"FrequencyId": "MONTHLY",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2022-05-03T20:21:48.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": false,
"ConsentAssociations": [
{
"ConsentType": "Opt-in Consent",
"ConsentVersion": "v1",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
]
}
],
"Emails": [
{
"EmailAddressType": "Primary",
"EmailAddress": "john.doe@example.com",
"IsDefault": false,
"Consents": [
{
"ConsentType": "Global Email Marketing Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:50:40.000Z",
"ExpirationDate": "2022-10-25T13:50:40.000Z",
"Expired": true,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"EmailPreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Email",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2023-01-09T14:26:45.280Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_email",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "Nurture-11"
}
],
"CustomerDate": "2023-01-09T14:26:41.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": false,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
}
}
],
"PhoneNumbers": [
{
"PhoneType": "Home",
"PhoneNumber": "7702551021",
"PhoneNumberNumeric": 7702551021,
"IsDefault": false,
"Consents": [
{
"ConsentType": "TCPA Landline Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2023-11-02T21:23:31.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Service App",
"UpdatedVersionPending": false,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T21:23:37.023Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Agent ID - 1334"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"IsMobile": false,
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2024-02-10T13:48:18.943Z",
"ModifiedBy": "My Accounts Page"
},
"PhonePreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Phone",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-02-10T13:48:18.943Z",
"UserId": "App_Preferences_Widget_SC22",
"SourceId": "In-app Widgets",
"FilterId": "fin_banking_phone",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2024-02-10T13:48:13.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false
}
],
"ProfilePreferences": [
{
"ProgramId": "ins_payment_confirmation",
"ChannelId": "Solicit",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2021-11-17T18:44:21.707Z",
"UserId": "My Accounts Page",
"SourceId": "Default",
"FilterId": "ins_payment_app_notify",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "App Id",
"Value": "JADKYK13343KD"
}
],
"CustomerDate": "2023-11-17T18:44:12.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"Consents": [
{
"ConsentType": "CCPA Privacy Rights",
"ConsentVersion": "v4",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:28:49.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2021-11-16T20:42:08.633Z",
"CreatedBy": "Web App",
"ModifiedDate": "2022-10-25T13:28:51.343Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "CA-USA"
}
]
}
],
"CustomFields": [
{
"Name": "Interests",
"Value": "Shopping::Camping and Outdoors::Online Gaming",
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"Groups": [
{
"GroupType": "Household",
"GroupName": "Family",
"IsPrimary": true,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T15:29:15.973Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"ProfileTags": [
{
"Name": "Frequent Customer"
}
]
}
]What made this section unhelpful for you?
Retrieve profiles by preference attributes
This method retrieves one or more profiles containing preferences that meet the specified attribute criteria. It selectively returns only those preferences that contain all of the specified attribute criteria.
Moreover, this method facilitates filtering based on multiple preference attributes, with parameters passed as an array. The initial key and value combination commence with index 0.
This method returns up to 50 profiles. If more than 50 matching profiles are found, the API returns a 403-Forbidden.
All active consents, custom fields, groups, tags, and preferences for which you have permissions will be returned in the response.
To illustrate, suppose you want to search for a profile with the preference attribute key "alpha" and a value of "couch," as well as another attribute key "beta" with a value of "book." In that case, you can use the following request as an example.
GET {clientId}/Profile/Preference/Attributes?attributes[0].Key=alpha&attributes[0].Value=phone&attributes[1].Key=beta&attributes[1].Value=account Header Parameters
Authorization token
Query Parameters
Optional parameter that, when set to true, returns consent history. When set to false, it returns only the latest consent information. Defaults to true.
Path Parameters
This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.
Response
Response Attributes
System-generated unique identifier associated with the profile. Read-only.
Defines whether the item is active or inactive.
Read-only system fields returned as part of an API response. These are updated automatically when a profile is created or modified.
Show child attributes
An optional field for clients to use at their discretion to accommodate scenarios in which customer profile verification is performed.
An identifier used to classify a person based on specific criteria. For example, it can represent their buying stage (prospect, lead, customer), firmographics (industry, company size), or any other criteria.
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.
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.
Name fields associated with the profile.
Show child attributes
Default Locale for the profile.
Shows 'Complete' if the record is processed, otherwise 'Pending Update.' Read-only.
An optional parameter used when deactivating a profile to specify the reason for deactivation.
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.
Show child attributes
A collection of mailing addresses associated with the profile. The address collection can also include any preferences and consents associated with it.
Show child attributes
A collection of email addresses associated with the profile. The email collection can also include any preferences and consents associated with it.
Show child attributes
A collection of phone numbers associated with the profile. The phone number collection can also include any preferences and consents associated with it.
Show child attributes
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.
Show child attributes
A collection of consents associated with the profile.
Show child attributes
A collection of custom fields associated with the profile.
Show child attributes
A collection of Groups associated with the profile.
Show child attributes
A collection of Tags associated with the profile.
Show child attributes
What made this section unhelpful for you?
Response
[
{
"ProfileId": 27178,
"IsActive": true,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"RegistrationConfirmed": true,
"CustomerType": "Lead",
"PreserveConsents": true,
"PreservePreferences": true,
"CustomerName": {
"FirstName": "John",
"MiddleName": "F",
"LastName": "Doe",
"Prefix": "Mr",
"Suffix": "Jr"
},
"DefaultLocale": "en_US",
"UpdateStatus": "Complete",
"ReasonCode": "",
"AlternateIds": [
{
"AlternateIdType": "Salesforce ContactId",
"AlternateId": "0031njkASSIs2kk909",
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
}
}
],
"Addresses": [
{
"Address1": "4400 River Green Parkway",
"Address2": "Suite 100",
"City": "Duluth",
"StateProvince": "GA",
"CountryCode_Numeric": "840",
"CountryCode_Alpha2": "US",
"CountryCode_Alpha3": "USA",
"PostalCode": "30096-2549",
"AddressType": "Work",
"IsActive": true,
"IsDefault": false,
"CassAddress1": "4400 RIVER GREEN PKWY",
"CassAddress2": "",
"CassCity": "DULUTH",
"CassStateProvince": "GA",
"CassPostalCode": "30096-2531",
"CassStatus": "Y",
"Country": "United States of America",
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"MissingRequiredConsents": false,
"Consents": [
{
"ConsentType": "Direct Mail Consent",
"ConsentVersion": "v1.0",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2024-10-25T13:50:40.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Lead Gen Form - 221",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
]
}
],
"AddressPreferences": [
{
"ProgramId": "in_banking_alert",
"ChannelId": "Mail",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-09-14T20:18:56.943Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_mail",
"PreferenceType": "2",
"FrequencyId": "MONTHLY",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2022-05-03T20:21:48.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": false,
"ConsentAssociations": [
{
"ConsentType": "Opt-in Consent",
"ConsentVersion": "v1",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
]
}
],
"Emails": [
{
"EmailAddressType": "Primary",
"EmailAddress": "john.doe@example.com",
"IsDefault": false,
"Consents": [
{
"ConsentType": "Global Email Marketing Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:50:40.000Z",
"ExpirationDate": "2022-10-25T13:50:40.000Z",
"Expired": true,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"EmailPreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Email",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2023-01-09T14:26:45.280Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_email",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "Nurture-11"
}
],
"CustomerDate": "2023-01-09T14:26:41.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": false,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
}
}
],
"PhoneNumbers": [
{
"PhoneType": "Home",
"PhoneNumber": "7702551021",
"PhoneNumberNumeric": 7702551021,
"IsDefault": false,
"Consents": [
{
"ConsentType": "TCPA Landline Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2023-11-02T21:23:31.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Service App",
"UpdatedVersionPending": false,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T21:23:37.023Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Agent ID - 1334"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"IsMobile": false,
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2024-02-10T13:48:18.943Z",
"ModifiedBy": "My Accounts Page"
},
"PhonePreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Phone",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-02-10T13:48:18.943Z",
"UserId": "App_Preferences_Widget_SC22",
"SourceId": "In-app Widgets",
"FilterId": "fin_banking_phone",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2024-02-10T13:48:13.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false
}
],
"ProfilePreferences": [
{
"ProgramId": "ins_payment_confirmation",
"ChannelId": "Solicit",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2021-11-17T18:44:21.707Z",
"UserId": "My Accounts Page",
"SourceId": "Default",
"FilterId": "ins_payment_app_notify",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "App Id",
"Value": "JADKYK13343KD"
}
],
"CustomerDate": "2023-11-17T18:44:12.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"Consents": [
{
"ConsentType": "CCPA Privacy Rights",
"ConsentVersion": "v4",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:28:49.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2021-11-16T20:42:08.633Z",
"CreatedBy": "Web App",
"ModifiedDate": "2022-10-25T13:28:51.343Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "CA-USA"
}
]
}
],
"CustomFields": [
{
"Name": "Interests",
"Value": "Shopping::Camping and Outdoors::Online Gaming",
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"Groups": [
{
"GroupType": "Household",
"GroupName": "Family",
"IsPrimary": true,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T15:29:15.973Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"ProfileTags": [
{
"Name": "Frequent Customer"
}
]
}
]What made this section unhelpful for you?
Retrieve group profiles by profile id
This method will retrieve one or more profiles that are part of a group by using the profileId of the group’s primary profile.
The response will include up to 50 profiles that belong to the group. If more than 50 profiles are found, the API returns a 403-Forbidden.
The response will include all active consents, custom fields, groups, tags, and preferences for which you have appropriate permissions.
Header Parameters
Authorization token
Query Parameters
Name of the group type present on the primary profile of the group.
Optional parameter used to filter the profiles returned based on the specified group name.
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 w...
Optional parameter that, when set to true, returns consent history. When set to false, it returns only the latest consent information. Defaults to true.
Path Parameters
This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.
System generated unique identifier of the profile.
Response
Response Attributes
System-generated unique identifier associated with the profile. Read-only.
Defines whether the item is active or inactive.
Read-only system fields returned as part of an API response. These are updated automatically when a profile is created or modified.
Show child attributes
An optional field for clients to use at their discretion to accommodate scenarios in which customer profile verification is performed.
An identifier used to classify a person based on specific criteria. For example, it can represent their buying stage (prospect, lead, customer), firmographics (industry, company size), or any other criteria.
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.
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.
Name fields associated with the profile.
Show child attributes
Default Locale for the profile.
Shows 'Complete' if the record is processed, otherwise 'Pending Update.' Read-only.
An optional parameter used when deactivating a profile to specify the reason for deactivation.
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.
Show child attributes
A collection of mailing addresses associated with the profile. The address collection can also include any preferences and consents associated with it.
Show child attributes
A collection of email addresses associated with the profile. The email collection can also include any preferences and consents associated with it.
Show child attributes
A collection of phone numbers associated with the profile. The phone number collection can also include any preferences and consents associated with it.
Show child attributes
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.
Show child attributes
A collection of consents associated with the profile.
Show child attributes
A collection of custom fields associated with the profile.
Show child attributes
A collection of Groups associated with the profile.
Show child attributes
A collection of Tags associated with the profile.
Show child attributes
What made this section unhelpful for you?
Response
[
{
"ProfileId": 27178,
"IsActive": true,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"RegistrationConfirmed": true,
"CustomerType": "Lead",
"PreserveConsents": true,
"PreservePreferences": true,
"CustomerName": {
"FirstName": "John",
"MiddleName": "F",
"LastName": "Doe",
"Prefix": "Mr",
"Suffix": "Jr"
},
"DefaultLocale": "en_US",
"UpdateStatus": "Complete",
"ReasonCode": "",
"AlternateIds": [
{
"AlternateIdType": "Salesforce ContactId",
"AlternateId": "0031njkASSIs2kk909",
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
}
}
],
"Addresses": [
{
"Address1": "4400 River Green Parkway",
"Address2": "Suite 100",
"City": "Duluth",
"StateProvince": "GA",
"CountryCode_Numeric": "840",
"CountryCode_Alpha2": "US",
"CountryCode_Alpha3": "USA",
"PostalCode": "30096-2549",
"AddressType": "Work",
"IsActive": true,
"IsDefault": false,
"CassAddress1": "4400 RIVER GREEN PKWY",
"CassAddress2": "",
"CassCity": "DULUTH",
"CassStateProvince": "GA",
"CassPostalCode": "30096-2531",
"CassStatus": "Y",
"Country": "United States of America",
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"MissingRequiredConsents": false,
"Consents": [
{
"ConsentType": "Direct Mail Consent",
"ConsentVersion": "v1.0",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2024-10-25T13:50:40.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Lead Gen Form - 221",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
]
}
],
"AddressPreferences": [
{
"ProgramId": "in_banking_alert",
"ChannelId": "Mail",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-09-14T20:18:56.943Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_mail",
"PreferenceType": "2",
"FrequencyId": "MONTHLY",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2022-05-03T20:21:48.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": false,
"ConsentAssociations": [
{
"ConsentType": "Opt-in Consent",
"ConsentVersion": "v1",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
]
}
],
"Emails": [
{
"EmailAddressType": "Primary",
"EmailAddress": "john.doe@example.com",
"IsDefault": false,
"Consents": [
{
"ConsentType": "Global Email Marketing Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:50:40.000Z",
"ExpirationDate": "2022-10-25T13:50:40.000Z",
"Expired": true,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"EmailPreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Email",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2023-01-09T14:26:45.280Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_email",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "Nurture-11"
}
],
"CustomerDate": "2023-01-09T14:26:41.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": false,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
}
}
],
"PhoneNumbers": [
{
"PhoneType": "Home",
"PhoneNumber": "7702551021",
"PhoneNumberNumeric": 7702551021,
"IsDefault": false,
"Consents": [
{
"ConsentType": "TCPA Landline Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2023-11-02T21:23:31.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Service App",
"UpdatedVersionPending": false,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T21:23:37.023Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Agent ID - 1334"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"IsMobile": false,
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2024-02-10T13:48:18.943Z",
"ModifiedBy": "My Accounts Page"
},
"PhonePreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Phone",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-02-10T13:48:18.943Z",
"UserId": "App_Preferences_Widget_SC22",
"SourceId": "In-app Widgets",
"FilterId": "fin_banking_phone",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2024-02-10T13:48:13.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false
}
],
"ProfilePreferences": [
{
"ProgramId": "ins_payment_confirmation",
"ChannelId": "Solicit",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2021-11-17T18:44:21.707Z",
"UserId": "My Accounts Page",
"SourceId": "Default",
"FilterId": "ins_payment_app_notify",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "App Id",
"Value": "JADKYK13343KD"
}
],
"CustomerDate": "2023-11-17T18:44:12.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"Consents": [
{
"ConsentType": "CCPA Privacy Rights",
"ConsentVersion": "v4",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:28:49.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2021-11-16T20:42:08.633Z",
"CreatedBy": "Web App",
"ModifiedDate": "2022-10-25T13:28:51.343Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "CA-USA"
}
]
}
],
"CustomFields": [
{
"Name": "Interests",
"Value": "Shopping::Camping and Outdoors::Online Gaming",
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"Groups": [
{
"GroupType": "Household",
"GroupName": "Family",
"IsPrimary": true,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T15:29:15.973Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"ProfileTags": [
{
"Name": "Frequent Customer"
}
]
}
]What made this section unhelpful for you?
Retrieve group profiles by alternate id
This method will retrieve one or more profiles that are part of a group by using the alternateId and alternateIdType combination of the group's primary profile.
The response will include up to 50 profiles that belong to the group. If more than 50 profiles are found, the API returns a 403-Forbidden.
The response will include all active consents, custom fields, groups, tags, and preferences for which you have appropriate permissions.
Header Parameters
Authorization token
Query Parameters
Name of the Alternate Id type associated with the specified Alternate Id.
The Alternate Id value associated with the Alternate Id type.
Name of the group type present on the primary profile of the group.
Optional parameter used to filter the profiles returned based on the specified group name.
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 w...
Optional parameter that, when set to true, returns consent history. When set to false, it returns only the latest consent information. Defaults to true.
Path Parameters
This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.
Response
Response Attributes
System-generated unique identifier associated with the profile. Read-only.
Defines whether the item is active or inactive.
Read-only system fields returned as part of an API response. These are updated automatically when a profile is created or modified.
Show child attributes
An optional field for clients to use at their discretion to accommodate scenarios in which customer profile verification is performed.
An identifier used to classify a person based on specific criteria. For example, it can represent their buying stage (prospect, lead, customer), firmographics (industry, company size), or any other criteria.
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.
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.
Name fields associated with the profile.
Show child attributes
Default Locale for the profile.
Shows 'Complete' if the record is processed, otherwise 'Pending Update.' Read-only.
An optional parameter used when deactivating a profile to specify the reason for deactivation.
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.
Show child attributes
A collection of mailing addresses associated with the profile. The address collection can also include any preferences and consents associated with it.
Show child attributes
A collection of email addresses associated with the profile. The email collection can also include any preferences and consents associated with it.
Show child attributes
A collection of phone numbers associated with the profile. The phone number collection can also include any preferences and consents associated with it.
Show child attributes
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.
Show child attributes
A collection of consents associated with the profile.
Show child attributes
A collection of custom fields associated with the profile.
Show child attributes
A collection of Groups associated with the profile.
Show child attributes
A collection of Tags associated with the profile.
Show child attributes
What made this section unhelpful for you?
Response
[
{
"ProfileId": 27178,
"IsActive": true,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"RegistrationConfirmed": true,
"CustomerType": "Lead",
"PreserveConsents": true,
"PreservePreferences": true,
"CustomerName": {
"FirstName": "John",
"MiddleName": "F",
"LastName": "Doe",
"Prefix": "Mr",
"Suffix": "Jr"
},
"DefaultLocale": "en_US",
"UpdateStatus": "Complete",
"ReasonCode": "",
"AlternateIds": [
{
"AlternateIdType": "Salesforce ContactId",
"AlternateId": "0031njkASSIs2kk909",
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
}
}
],
"Addresses": [
{
"Address1": "4400 River Green Parkway",
"Address2": "Suite 100",
"City": "Duluth",
"StateProvince": "GA",
"CountryCode_Numeric": "840",
"CountryCode_Alpha2": "US",
"CountryCode_Alpha3": "USA",
"PostalCode": "30096-2549",
"AddressType": "Work",
"IsActive": true,
"IsDefault": false,
"CassAddress1": "4400 RIVER GREEN PKWY",
"CassAddress2": "",
"CassCity": "DULUTH",
"CassStateProvince": "GA",
"CassPostalCode": "30096-2531",
"CassStatus": "Y",
"Country": "United States of America",
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"MissingRequiredConsents": false,
"Consents": [
{
"ConsentType": "Direct Mail Consent",
"ConsentVersion": "v1.0",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2024-10-25T13:50:40.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Lead Gen Form - 221",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
]
}
],
"AddressPreferences": [
{
"ProgramId": "in_banking_alert",
"ChannelId": "Mail",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-09-14T20:18:56.943Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_mail",
"PreferenceType": "2",
"FrequencyId": "MONTHLY",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2022-05-03T20:21:48.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": false,
"ConsentAssociations": [
{
"ConsentType": "Opt-in Consent",
"ConsentVersion": "v1",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
]
}
],
"Emails": [
{
"EmailAddressType": "Primary",
"EmailAddress": "john.doe@example.com",
"IsDefault": false,
"Consents": [
{
"ConsentType": "Global Email Marketing Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:50:40.000Z",
"ExpirationDate": "2022-10-25T13:50:40.000Z",
"Expired": true,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"EmailPreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Email",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2023-01-09T14:26:45.280Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_email",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "Nurture-11"
}
],
"CustomerDate": "2023-01-09T14:26:41.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": false,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
}
}
],
"PhoneNumbers": [
{
"PhoneType": "Home",
"PhoneNumber": "7702551021",
"PhoneNumberNumeric": 7702551021,
"IsDefault": false,
"Consents": [
{
"ConsentType": "TCPA Landline Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2023-11-02T21:23:31.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Service App",
"UpdatedVersionPending": false,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T21:23:37.023Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Agent ID - 1334"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"IsMobile": false,
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2024-02-10T13:48:18.943Z",
"ModifiedBy": "My Accounts Page"
},
"PhonePreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Phone",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-02-10T13:48:18.943Z",
"UserId": "App_Preferences_Widget_SC22",
"SourceId": "In-app Widgets",
"FilterId": "fin_banking_phone",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2024-02-10T13:48:13.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false
}
],
"ProfilePreferences": [
{
"ProgramId": "ins_payment_confirmation",
"ChannelId": "Solicit",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2021-11-17T18:44:21.707Z",
"UserId": "My Accounts Page",
"SourceId": "Default",
"FilterId": "ins_payment_app_notify",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "App Id",
"Value": "JADKYK13343KD"
}
],
"CustomerDate": "2023-11-17T18:44:12.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"Consents": [
{
"ConsentType": "CCPA Privacy Rights",
"ConsentVersion": "v4",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:28:49.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2021-11-16T20:42:08.633Z",
"CreatedBy": "Web App",
"ModifiedDate": "2022-10-25T13:28:51.343Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "CA-USA"
}
]
}
],
"CustomFields": [
{
"Name": "Interests",
"Value": "Shopping::Camping and Outdoors::Online Gaming",
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"Groups": [
{
"GroupType": "Household",
"GroupName": "Family",
"IsPrimary": true,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T15:29:15.973Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"ProfileTags": [
{
"Name": "Frequent Customer"
}
]
}
]What made this section unhelpful for you?
Retrieve group profiles by phone number
This method will retrieve one or more profiles that are part of a group by using the phoneNumber of a primary profile of the group.
The response will include up to 50 profiles that belong to the group. If more than 50 profiles are found, the API returns a 403-Forbidden.
The response will include all active consents, custom fields, groups, tags, and preferences for which you have appropriate permissions.
Header Parameters
Authorization token
Query Parameters
The phone number associated with the primary profile of the group, used to retrieve all profiles within the group.
Name of the phone type associated with the specified phone number. This allows you to filter the results to a specific phone type.
Name of the group type present on the primary profile of the group.
Optional parameter used to filter the profiles returned based on the specified group name.
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 w...
Optional parameter that, when set to true, returns consent history. When set to false, it returns only the latest consent information. Defaults to true.
Path Parameters
This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.
Response
Response Attributes
System-generated unique identifier associated with the profile. Read-only.
Defines whether the item is active or inactive.
Read-only system fields returned as part of an API response. These are updated automatically when a profile is created or modified.
Show child attributes
An optional field for clients to use at their discretion to accommodate scenarios in which customer profile verification is performed.
An identifier used to classify a person based on specific criteria. For example, it can represent their buying stage (prospect, lead, customer), firmographics (industry, company size), or any other criteria.
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.
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.
Name fields associated with the profile.
Show child attributes
Default Locale for the profile.
Shows 'Complete' if the record is processed, otherwise 'Pending Update.' Read-only.
An optional parameter used when deactivating a profile to specify the reason for deactivation.
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.
Show child attributes
A collection of mailing addresses associated with the profile. The address collection can also include any preferences and consents associated with it.
Show child attributes
A collection of email addresses associated with the profile. The email collection can also include any preferences and consents associated with it.
Show child attributes
A collection of phone numbers associated with the profile. The phone number collection can also include any preferences and consents associated with it.
Show child attributes
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.
Show child attributes
A collection of consents associated with the profile.
Show child attributes
A collection of custom fields associated with the profile.
Show child attributes
A collection of Groups associated with the profile.
Show child attributes
A collection of Tags associated with the profile.
Show child attributes
What made this section unhelpful for you?
Response
[
{
"ProfileId": 27178,
"IsActive": true,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"RegistrationConfirmed": true,
"CustomerType": "Lead",
"PreserveConsents": true,
"PreservePreferences": true,
"CustomerName": {
"FirstName": "John",
"MiddleName": "F",
"LastName": "Doe",
"Prefix": "Mr",
"Suffix": "Jr"
},
"DefaultLocale": "en_US",
"UpdateStatus": "Complete",
"ReasonCode": "",
"AlternateIds": [
{
"AlternateIdType": "Salesforce ContactId",
"AlternateId": "0031njkASSIs2kk909",
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
}
}
],
"Addresses": [
{
"Address1": "4400 River Green Parkway",
"Address2": "Suite 100",
"City": "Duluth",
"StateProvince": "GA",
"CountryCode_Numeric": "840",
"CountryCode_Alpha2": "US",
"CountryCode_Alpha3": "USA",
"PostalCode": "30096-2549",
"AddressType": "Work",
"IsActive": true,
"IsDefault": false,
"CassAddress1": "4400 RIVER GREEN PKWY",
"CassAddress2": "",
"CassCity": "DULUTH",
"CassStateProvince": "GA",
"CassPostalCode": "30096-2531",
"CassStatus": "Y",
"Country": "United States of America",
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"MissingRequiredConsents": false,
"Consents": [
{
"ConsentType": "Direct Mail Consent",
"ConsentVersion": "v1.0",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2024-10-25T13:50:40.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Lead Gen Form - 221",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
]
}
],
"AddressPreferences": [
{
"ProgramId": "in_banking_alert",
"ChannelId": "Mail",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-09-14T20:18:56.943Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_mail",
"PreferenceType": "2",
"FrequencyId": "MONTHLY",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2022-05-03T20:21:48.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": false,
"ConsentAssociations": [
{
"ConsentType": "Opt-in Consent",
"ConsentVersion": "v1",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
]
}
],
"Emails": [
{
"EmailAddressType": "Primary",
"EmailAddress": "john.doe@example.com",
"IsDefault": false,
"Consents": [
{
"ConsentType": "Global Email Marketing Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:50:40.000Z",
"ExpirationDate": "2022-10-25T13:50:40.000Z",
"Expired": true,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"EmailPreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Email",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2023-01-09T14:26:45.280Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_email",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "Nurture-11"
}
],
"CustomerDate": "2023-01-09T14:26:41.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": false,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
}
}
],
"PhoneNumbers": [
{
"PhoneType": "Home",
"PhoneNumber": "7702551021",
"PhoneNumberNumeric": 7702551021,
"IsDefault": false,
"Consents": [
{
"ConsentType": "TCPA Landline Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2023-11-02T21:23:31.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Service App",
"UpdatedVersionPending": false,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T21:23:37.023Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Agent ID - 1334"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"IsMobile": false,
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2024-02-10T13:48:18.943Z",
"ModifiedBy": "My Accounts Page"
},
"PhonePreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Phone",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-02-10T13:48:18.943Z",
"UserId": "App_Preferences_Widget_SC22",
"SourceId": "In-app Widgets",
"FilterId": "fin_banking_phone",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2024-02-10T13:48:13.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false
}
],
"ProfilePreferences": [
{
"ProgramId": "ins_payment_confirmation",
"ChannelId": "Solicit",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2021-11-17T18:44:21.707Z",
"UserId": "My Accounts Page",
"SourceId": "Default",
"FilterId": "ins_payment_app_notify",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "App Id",
"Value": "JADKYK13343KD"
}
],
"CustomerDate": "2023-11-17T18:44:12.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"Consents": [
{
"ConsentType": "CCPA Privacy Rights",
"ConsentVersion": "v4",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:28:49.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2021-11-16T20:42:08.633Z",
"CreatedBy": "Web App",
"ModifiedDate": "2022-10-25T13:28:51.343Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "CA-USA"
}
]
}
],
"CustomFields": [
{
"Name": "Interests",
"Value": "Shopping::Camping and Outdoors::Online Gaming",
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"Groups": [
{
"GroupType": "Household",
"GroupName": "Family",
"IsPrimary": true,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T15:29:15.973Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"ProfileTags": [
{
"Name": "Frequent Customer"
}
]
}
]What made this section unhelpful for you?
Retrieve group profiles by email address
This method will retrieve one or more profiles that are part of a group by using an emailAddress of the group's primary profile.
The response will include up to 50 profiles that belong to the group. If more than 50 profiles are found, the API returns a 403-Forbidden.
The response will include all active consents, custom fields, groups, tags, and preferences for which you have appropriate permissions.
Header Parameters
Authorization token
Query Parameters
The email address associated with the primary profile of the group, used to retrieve all profiles within the group.
Name of the email type associated with the specified email address. This allows you to filter the results to a specific email type.
Name of the group type present on the primary profile of the group.
Optional parameter used to filter the profiles returned based on the specified group name.
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 w...
Optional parameter that, when set to true, returns consent history. When set to false, it returns only the latest consent information. Defaults to true.
Path Parameters
This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.
Response
Response Attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
What made this section unhelpful for you?
Response
[
{
"ProfileId": 27178,
"IsActive": true,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"RegistrationConfirmed": true,
"CustomerType": "Lead",
"PreserveConsents": true,
"PreservePreferences": true,
"CustomerName": {
"FirstName": "John",
"MiddleName": "F",
"LastName": "Doe",
"Prefix": "Mr",
"Suffix": "Jr"
},
"DefaultLocale": "en_US",
"UpdateStatus": "Complete",
"ReasonCode": "",
"AlternateIds": [
{
"AlternateIdType": "Salesforce ContactId",
"AlternateId": "0031njkASSIs2kk909",
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
}
}
],
"Addresses": [
{
"Address1": "4400 River Green Parkway",
"Address2": "Suite 100",
"City": "Duluth",
"StateProvince": "GA",
"CountryCode_Numeric": "840",
"CountryCode_Alpha2": "US",
"CountryCode_Alpha3": "USA",
"PostalCode": "30096-2549",
"AddressType": "Work",
"IsActive": true,
"IsDefault": false,
"CassAddress1": "4400 RIVER GREEN PKWY",
"CassAddress2": "",
"CassCity": "DULUTH",
"CassStateProvince": "GA",
"CassPostalCode": "30096-2531",
"CassStatus": "Y",
"Country": "United States of America",
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"MissingRequiredConsents": false,
"Consents": [
{
"ConsentType": "Direct Mail Consent",
"ConsentVersion": "v1.0",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2024-10-25T13:50:40.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Lead Gen Form - 221",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
]
}
],
"AddressPreferences": [
{
"ProgramId": "in_banking_alert",
"ChannelId": "Mail",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-09-14T20:18:56.943Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_mail",
"PreferenceType": "2",
"FrequencyId": "MONTHLY",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2022-05-03T20:21:48.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": false,
"ConsentAssociations": [
{
"ConsentType": "Opt-in Consent",
"ConsentVersion": "v1",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
]
}
],
"Emails": [
{
"EmailAddressType": "Primary",
"EmailAddress": "john.doe@example.com",
"IsDefault": false,
"Consents": [
{
"ConsentType": "Global Email Marketing Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:50:40.000Z",
"ExpirationDate": "2022-10-25T13:50:40.000Z",
"Expired": true,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"EmailPreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Email",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2023-01-09T14:26:45.280Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_email",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "Nurture-11"
}
],
"CustomerDate": "2023-01-09T14:26:41.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": false,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
}
}
],
"PhoneNumbers": [
{
"PhoneType": "Home",
"PhoneNumber": "7702551021",
"PhoneNumberNumeric": 7702551021,
"IsDefault": false,
"Consents": [
{
"ConsentType": "TCPA Landline Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2023-11-02T21:23:31.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Service App",
"UpdatedVersionPending": false,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T21:23:37.023Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Agent ID - 1334"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"IsMobile": false,
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2024-02-10T13:48:18.943Z",
"ModifiedBy": "My Accounts Page"
},
"PhonePreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Phone",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-02-10T13:48:18.943Z",
"UserId": "App_Preferences_Widget_SC22",
"SourceId": "In-app Widgets",
"FilterId": "fin_banking_phone",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2024-02-10T13:48:13.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false
}
],
"ProfilePreferences": [
{
"ProgramId": "ins_payment_confirmation",
"ChannelId": "Solicit",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2021-11-17T18:44:21.707Z",
"UserId": "My Accounts Page",
"SourceId": "Default",
"FilterId": "ins_payment_app_notify",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "App Id",
"Value": "JADKYK13343KD"
}
],
"CustomerDate": "2023-11-17T18:44:12.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"Consents": [
{
"ConsentType": "CCPA Privacy Rights",
"ConsentVersion": "v4",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:28:49.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2021-11-16T20:42:08.633Z",
"CreatedBy": "Web App",
"ModifiedDate": "2022-10-25T13:28:51.343Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "CA-USA"
}
]
}
],
"CustomFields": [
{
"Name": "Interests",
"Value": "Shopping::Camping and Outdoors::Online Gaming",
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"Groups": [
{
"GroupType": "Household",
"GroupName": "Family",
"IsPrimary": true,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T15:29:15.973Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"ProfileTags": [
{
"Name": "Frequent Customer"
}
]
}
]What made this section unhelpful for you?
Retrieve group profiles by group name
This method will retrieve one or more profiles that are part of a group by using the groupName and groupType combination of the group's primary profile.
The response will include up to 50 profiles that belong to the group. If more than 50 profiles are found, the API returns a 403-Forbidden.
The response will include all active consents, custom fields, groups, tags, and preferences for which you have appropriate permissions.
Header Parameters
Authorization token
Query Parameters
Name of the group type associated with the desired profiles to retrieve.
The name of the group associated with the specified group type on the primary profile of the group.
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 outpu...
Optional parameter that, when set to true, returns consent history. When set to false, it returns only the latest consent information. Defaults to true.
Path Parameters
This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.
Response
Response Attributes
System-generated unique identifier associated with the profile. Read-only.
Defines whether the item is active or inactive.
Read-only system fields returned as part of an API response. These are updated automatically when a profile is created or modified.
Show child attributes
An optional field for clients to use at their discretion to accommodate scenarios in which customer profile verification is performed.
An identifier used to classify a person based on specific criteria. For example, it can represent their buying stage (prospect, lead, customer), firmographics (industry, company size), or any other criteria.
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.
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.
Name fields associated with the profile.
Show child attributes
Default Locale for the profile.
Shows 'Complete' if the record is processed, otherwise 'Pending Update.' Read-only.
An optional parameter used when deactivating a profile to specify the reason for deactivation.
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.
Show child attributes
A collection of mailing addresses associated with the profile. The address collection can also include any preferences and consents associated with it.
Show child attributes
A collection of email addresses associated with the profile. The email collection can also include any preferences and consents associated with it.
Show child attributes
A collection of phone numbers associated with the profile. The phone number collection can also include any preferences and consents associated with it.
Show child attributes
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.
Show child attributes
A collection of consents associated with the profile.
Show child attributes
A collection of custom fields associated with the profile.
Show child attributes
A collection of Groups associated with the profile.
Show child attributes
A collection of Tags associated with the profile.
Show child attributes
What made this section unhelpful for you?
Response
[
{
"ProfileId": 27178,
"IsActive": true,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"RegistrationConfirmed": true,
"CustomerType": "Lead",
"PreserveConsents": true,
"PreservePreferences": true,
"CustomerName": {
"FirstName": "John",
"MiddleName": "F",
"LastName": "Doe",
"Prefix": "Mr",
"Suffix": "Jr"
},
"DefaultLocale": "en_US",
"UpdateStatus": "Complete",
"ReasonCode": "",
"AlternateIds": [
{
"AlternateIdType": "Salesforce ContactId",
"AlternateId": "0031njkASSIs2kk909",
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
}
}
],
"Addresses": [
{
"Address1": "4400 River Green Parkway",
"Address2": "Suite 100",
"City": "Duluth",
"StateProvince": "GA",
"CountryCode_Numeric": "840",
"CountryCode_Alpha2": "US",
"CountryCode_Alpha3": "USA",
"PostalCode": "30096-2549",
"AddressType": "Work",
"IsActive": true,
"IsDefault": false,
"CassAddress1": "4400 RIVER GREEN PKWY",
"CassAddress2": "",
"CassCity": "DULUTH",
"CassStateProvince": "GA",
"CassPostalCode": "30096-2531",
"CassStatus": "Y",
"Country": "United States of America",
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"MissingRequiredConsents": false,
"Consents": [
{
"ConsentType": "Direct Mail Consent",
"ConsentVersion": "v1.0",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2024-10-25T13:50:40.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Lead Gen Form - 221",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
]
}
],
"AddressPreferences": [
{
"ProgramId": "in_banking_alert",
"ChannelId": "Mail",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-09-14T20:18:56.943Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_mail",
"PreferenceType": "2",
"FrequencyId": "MONTHLY",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2022-05-03T20:21:48.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": false,
"ConsentAssociations": [
{
"ConsentType": "Opt-in Consent",
"ConsentVersion": "v1",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
]
}
],
"Emails": [
{
"EmailAddressType": "Primary",
"EmailAddress": "john.doe@example.com",
"IsDefault": false,
"Consents": [
{
"ConsentType": "Global Email Marketing Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:50:40.000Z",
"ExpirationDate": "2022-10-25T13:50:40.000Z",
"Expired": true,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"EmailPreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Email",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2023-01-09T14:26:45.280Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_email",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "Nurture-11"
}
],
"CustomerDate": "2023-01-09T14:26:41.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": false,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
}
}
],
"PhoneNumbers": [
{
"PhoneType": "Home",
"PhoneNumber": "7702551021",
"PhoneNumberNumeric": 7702551021,
"IsDefault": false,
"Consents": [
{
"ConsentType": "TCPA Landline Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2023-11-02T21:23:31.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Service App",
"UpdatedVersionPending": false,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T21:23:37.023Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Agent ID - 1334"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"IsMobile": false,
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2024-02-10T13:48:18.943Z",
"ModifiedBy": "My Accounts Page"
},
"PhonePreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Phone",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-02-10T13:48:18.943Z",
"UserId": "App_Preferences_Widget_SC22",
"SourceId": "In-app Widgets",
"FilterId": "fin_banking_phone",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2024-02-10T13:48:13.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false
}
],
"ProfilePreferences": [
{
"ProgramId": "ins_payment_confirmation",
"ChannelId": "Solicit",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2021-11-17T18:44:21.707Z",
"UserId": "My Accounts Page",
"SourceId": "Default",
"FilterId": "ins_payment_app_notify",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "App Id",
"Value": "JADKYK13343KD"
}
],
"CustomerDate": "2023-11-17T18:44:12.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"Consents": [
{
"ConsentType": "CCPA Privacy Rights",
"ConsentVersion": "v4",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:28:49.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2021-11-16T20:42:08.633Z",
"CreatedBy": "Web App",
"ModifiedDate": "2022-10-25T13:28:51.343Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "CA-USA"
}
]
}
],
"CustomFields": [
{
"Name": "Interests",
"Value": "Shopping::Camping and Outdoors::Online Gaming",
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"Groups": [
{
"GroupType": "Household",
"GroupName": "Family",
"IsPrimary": true,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T15:29:15.973Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"ProfileTags": [
{
"Name": "Frequent Customer"
}
]
}
]What made this section unhelpful for you?
Update profile (POST)
Using this method, you can update a profile directly by utilizing the known profileId without the need to retrieve the profile beforehand. 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.
Header Parameters
Authorization token
Path Parameters
This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.
System generated unique identifier of the profile.
Body Parameters
A collection of consents associated with the User Profile.
Show child attributes
A collection of Custom Fields associated with the profile.
Show child attributes
A collection of Groups associated with the profile.
Show child attributes
A collection of Tags associated with the profile.
Show child attributes
Collection of addresses associated with the profile.
Show child attributes
A collection of email addresses associated with the profile. The email collection can also include any preferences and consents associated with it.
Show child attributes
A collection of phone numbers associated with the profile. The phone number collection can also include any preferences and consents associated with it.
Show child attributes
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.
Show child attributes
Read-Only Id associated with the Profile.
Defines whether the item is Active or Inactive.
Read-only system fields returned as part of an API response. These are updated automatically when a profile is created or modified.
Show child attributes
An optional field for clients to use at their discretion to accommodate scenarios in which customer profile verification is performed.
An identifier used to classify a person by the type of customer. For example: Retail, Commercial, or Marketing.
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.
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.
Name fields associated with the profile.
Show child attributes
Default Locale for the profile.
Read-Only field. 'Complete' if the record has been processed otherwise 'Pending Update'.
An optional parameter that can be passed when deactivating a profile.
Collection of AlternateIds associated with the profile.
Show child attributes
Response
Response Attributes
System-generated unique identifier associated with the profile. Read-only.
Defines whether the item is active or inactive.
Read-only system fields returned as part of an API response. These are updated automatically when a profile is created or modified.
Show child attributes
An optional field for clients to use at their discretion to accommodate scenarios in which customer profile verification is performed.
An identifier used to classify a person based on specific criteria. For example, it can represent their buying stage (prospect, lead, customer), firmographics (industry, company size), or any other criteria.
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.
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.
Name fields associated with the profile.
Show child attributes
Default Locale for the profile.
Shows 'Complete' if the record is processed, otherwise 'Pending Update.' Read-only.
An optional parameter used when deactivating a profile to specify the reason for deactivation.
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.
Show child attributes
A collection of mailing addresses associated with the profile. The address collection can also include any preferences and consents associated with it.
Show child attributes
A collection of email addresses associated with the profile. The email collection can also include any preferences and consents associated with it.
Show child attributes
A collection of phone numbers associated with the profile. The phone number collection can also include any preferences and consents associated with it.
Show child attributes
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.
Show child attributes
A collection of consents associated with the profile.
Show child attributes
A collection of custom fields associated with the profile.
Show child attributes
A collection of Groups associated with the profile.
Show child attributes
A collection of Tags associated with the profile.
Show child attributes
What made this section unhelpful for you?
Response
{
"ProfileId": 27178,
"IsActive": true,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"RegistrationConfirmed": true,
"CustomerType": "Lead",
"PreserveConsents": true,
"PreservePreferences": true,
"CustomerName": {
"FirstName": "John",
"MiddleName": "F",
"LastName": "Doe",
"Prefix": "Mr",
"Suffix": "Jr"
},
"DefaultLocale": "en_US",
"UpdateStatus": "Complete",
"ReasonCode": "",
"AlternateIds": [
{
"AlternateIdType": "Salesforce ContactId",
"AlternateId": "0031njkASSIs2kk909",
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
}
}
],
"Addresses": [
{
"Address1": "4400 River Green Parkway",
"Address2": "Suite 100",
"City": "Duluth",
"StateProvince": "GA",
"CountryCode_Numeric": "840",
"CountryCode_Alpha2": "US",
"CountryCode_Alpha3": "USA",
"PostalCode": "30096-2549",
"AddressType": "Work",
"IsActive": true,
"IsDefault": false,
"CassAddress1": "4400 RIVER GREEN PKWY",
"CassAddress2": "",
"CassCity": "DULUTH",
"CassStateProvince": "GA",
"CassPostalCode": "30096-2531",
"CassStatus": "Y",
"Country": "United States of America",
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"MissingRequiredConsents": false,
"Consents": [
{
"ConsentType": "Direct Mail Consent",
"ConsentVersion": "v1.0",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2024-10-25T13:50:40.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Lead Gen Form - 221",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
]
}
],
"AddressPreferences": [
{
"ProgramId": "in_banking_alert",
"ChannelId": "Mail",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-09-14T20:18:56.943Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_mail",
"PreferenceType": "2",
"FrequencyId": "MONTHLY",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2022-05-03T20:21:48.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": false,
"ConsentAssociations": [
{
"ConsentType": "Opt-in Consent",
"ConsentVersion": "v1",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
]
}
],
"Emails": [
{
"EmailAddressType": "Primary",
"EmailAddress": "john.doe@example.com",
"IsDefault": false,
"Consents": [
{
"ConsentType": "Global Email Marketing Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:50:40.000Z",
"ExpirationDate": "2022-10-25T13:50:40.000Z",
"Expired": true,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"EmailPreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Email",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2023-01-09T14:26:45.280Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_email",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "Nurture-11"
}
],
"CustomerDate": "2023-01-09T14:26:41.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": false,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
}
}
],
"PhoneNumbers": [
{
"PhoneType": "Home",
"PhoneNumber": "7702551021",
"PhoneNumberNumeric": 7702551021,
"IsDefault": false,
"Consents": [
{
"ConsentType": "TCPA Landline Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2023-11-02T21:23:31.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Service App",
"UpdatedVersionPending": false,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T21:23:37.023Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Agent ID - 1334"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"IsMobile": false,
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2024-02-10T13:48:18.943Z",
"ModifiedBy": "My Accounts Page"
},
"PhonePreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Phone",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-02-10T13:48:18.943Z",
"UserId": "App_Preferences_Widget_SC22",
"SourceId": "In-app Widgets",
"FilterId": "fin_banking_phone",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2024-02-10T13:48:13.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false
}
],
"ProfilePreferences": [
{
"ProgramId": "ins_payment_confirmation",
"ChannelId": "Solicit",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2021-11-17T18:44:21.707Z",
"UserId": "My Accounts Page",
"SourceId": "Default",
"FilterId": "ins_payment_app_notify",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "App Id",
"Value": "JADKYK13343KD"
}
],
"CustomerDate": "2023-11-17T18:44:12.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"Consents": [
{
"ConsentType": "CCPA Privacy Rights",
"ConsentVersion": "v4",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:28:49.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2021-11-16T20:42:08.633Z",
"CreatedBy": "Web App",
"ModifiedDate": "2022-10-25T13:28:51.343Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "CA-USA"
}
]
}
],
"CustomFields": [
{
"Name": "Interests",
"Value": "Shopping::Camping and Outdoors::Online Gaming",
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"Groups": [
{
"GroupType": "Household",
"GroupName": "Family",
"IsPrimary": true,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T15:29:15.973Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"ProfileTags": [
{
"Name": "Frequent Customer"
}
]
}What made this section unhelpful for you?
Update profile (PUT)
This method allows you to overwrite a profile by specifying the corresponding profileId.
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.
Header Parameters
Authorization token
Path Parameters
This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.
System generated unique identifier of the profile.
Body Parameters
System-generated unique identifier associated with the profile. Read-only.
Defines whether the item is active or inactive.
Read-only system fields returned as part of an API response. These are updated automatically when a profile is created or modified.
Show child attributes
An optional field for clients to use at their discretion to accommodate scenarios in which customer profile verification is performed.
An identifier used to classify a person based on specific criteria. For example, it can represent their buying stage (prospect, lead, customer), firmographics (industry, company size), or any other criteria.
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.
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.
Name fields associated with the profile.
Show child attributes
Default Locale for the profile.
Shows 'Complete' if the record is processed, otherwise 'Pending Update.' Read-only.
An optional parameter used when deactivating a profile to specify the reason for deactivation.
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.
Show child attributes
A collection of mailing addresses associated with the profile. The address collection can also include any preferences and consents associated with it.
Show child attributes
A collection of email addresses associated with the profile. The email collection can also include any preferences and consents associated with it.
Show child attributes
A collection of phone numbers associated with the profile. The phone number collection can also include any preferences and consents associated with it.
Show child attributes
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.
Show child attributes
A collection of consents associated with the profile.
Show child attributes
A collection of custom fields associated with the profile.
Show child attributes
A collection of Groups associated with the profile.
Show child attributes
A collection of Tags associated with the profile.
Show child attributes
Response
Response Attributes
System-generated unique identifier associated with the profile. Read-only.
Defines whether the item is active or inactive.
Read-only system fields returned as part of an API response. These are updated automatically when a profile is created or modified.
Show child attributes
An optional field for clients to use at their discretion to accommodate scenarios in which customer profile verification is performed.
An identifier used to classify a person based on specific criteria. For example, it can represent their buying stage (prospect, lead, customer), firmographics (industry, company size), or any other criteria.
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.
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.
Name fields associated with the profile.
Show child attributes
Default Locale for the profile.
Shows 'Complete' if the record is processed, otherwise 'Pending Update.' Read-only.
An optional parameter used when deactivating a profile to specify the reason for deactivation.
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.
Show child attributes
A collection of mailing addresses associated with the profile. The address collection can also include any preferences and consents associated with it.
Show child attributes
A collection of email addresses associated with the profile. The email collection can also include any preferences and consents associated with it.
Show child attributes
A collection of phone numbers associated with the profile. The phone number collection can also include any preferences and consents associated with it.
Show child attributes
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.
Show child attributes
A collection of consents associated with the profile.
Show child attributes
A collection of custom fields associated with the profile.
Show child attributes
A collection of Groups associated with the profile.
Show child attributes
A collection of Tags associated with the profile.
Show child attributes
What made this section unhelpful for you?
Response
{
"ProfileId": 27178,
"IsActive": true,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"RegistrationConfirmed": true,
"CustomerType": "Lead",
"PreserveConsents": true,
"PreservePreferences": true,
"CustomerName": {
"FirstName": "John",
"MiddleName": "F",
"LastName": "Doe",
"Prefix": "Mr",
"Suffix": "Jr"
},
"DefaultLocale": "en_US",
"UpdateStatus": "Complete",
"ReasonCode": "",
"AlternateIds": [
{
"AlternateIdType": "Salesforce ContactId",
"AlternateId": "0031njkASSIs2kk909",
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
}
}
],
"Addresses": [
{
"Address1": "4400 River Green Parkway",
"Address2": "Suite 100",
"City": "Duluth",
"StateProvince": "GA",
"CountryCode_Numeric": "840",
"CountryCode_Alpha2": "US",
"CountryCode_Alpha3": "USA",
"PostalCode": "30096-2549",
"AddressType": "Work",
"IsActive": true,
"IsDefault": false,
"CassAddress1": "4400 RIVER GREEN PKWY",
"CassAddress2": "",
"CassCity": "DULUTH",
"CassStateProvince": "GA",
"CassPostalCode": "30096-2531",
"CassStatus": "Y",
"Country": "United States of America",
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"MissingRequiredConsents": false,
"Consents": [
{
"ConsentType": "Direct Mail Consent",
"ConsentVersion": "v1.0",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2024-10-25T13:50:40.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Lead Gen Form - 221",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
]
}
],
"AddressPreferences": [
{
"ProgramId": "in_banking_alert",
"ChannelId": "Mail",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-09-14T20:18:56.943Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_mail",
"PreferenceType": "2",
"FrequencyId": "MONTHLY",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2022-05-03T20:21:48.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": false,
"ConsentAssociations": [
{
"ConsentType": "Opt-in Consent",
"ConsentVersion": "v1",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
]
}
],
"Emails": [
{
"EmailAddressType": "Primary",
"EmailAddress": "john.doe@example.com",
"IsDefault": false,
"Consents": [
{
"ConsentType": "Global Email Marketing Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:50:40.000Z",
"ExpirationDate": "2022-10-25T13:50:40.000Z",
"Expired": true,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"EmailPreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Email",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2023-01-09T14:26:45.280Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_email",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "Nurture-11"
}
],
"CustomerDate": "2023-01-09T14:26:41.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": false,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
}
}
],
"PhoneNumbers": [
{
"PhoneType": "Home",
"PhoneNumber": "7702551021",
"PhoneNumberNumeric": 7702551021,
"IsDefault": false,
"Consents": [
{
"ConsentType": "TCPA Landline Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2023-11-02T21:23:31.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Service App",
"UpdatedVersionPending": false,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T21:23:37.023Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Agent ID - 1334"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"IsMobile": false,
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2024-02-10T13:48:18.943Z",
"ModifiedBy": "My Accounts Page"
},
"PhonePreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Phone",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-02-10T13:48:18.943Z",
"UserId": "App_Preferences_Widget_SC22",
"SourceId": "In-app Widgets",
"FilterId": "fin_banking_phone",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2024-02-10T13:48:13.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false
}
],
"ProfilePreferences": [
{
"ProgramId": "ins_payment_confirmation",
"ChannelId": "Solicit",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2021-11-17T18:44:21.707Z",
"UserId": "My Accounts Page",
"SourceId": "Default",
"FilterId": "ins_payment_app_notify",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "App Id",
"Value": "JADKYK13343KD"
}
],
"CustomerDate": "2023-11-17T18:44:12.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"Consents": [
{
"ConsentType": "CCPA Privacy Rights",
"ConsentVersion": "v4",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:28:49.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2021-11-16T20:42:08.633Z",
"CreatedBy": "Web App",
"ModifiedDate": "2022-10-25T13:28:51.343Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "CA-USA"
}
]
}
],
"CustomFields": [
{
"Name": "Interests",
"Value": "Shopping::Camping and Outdoors::Online Gaming",
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"Groups": [
{
"GroupType": "Household",
"GroupName": "Family",
"IsPrimary": true,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T15:29:15.973Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"ProfileTags": [
{
"Name": "Frequent Customer"
}
]
}What made this section unhelpful for you?
Update profile (PATCH)
The PATCH method applies partial modifications to a single profile specified by the profileId 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 here to learn about 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.
Header Parameters
Authorization token
Path Parameters
This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.
System generated unique identifier of the profile.
Body Parameters
Operation to be performed on the target object. Valid values are: add/remove/replace/test.
JSON pointer that references a location within the target document where the operation is performed.
JSON pointer to the location to copy or move.
Value to be added or replaced.
Response
Response Attributes
A collection of consents associated with the User Profile.
Show child attributes
A collection of Custom Fields associated with the profile.
Show child attributes
A collection of Groups associated with the profile.
Show child attributes
A collection of Tags associated with the profile.
Show child attributes
Collection of addresses associated with the profile.
Show child attributes
A collection of email addresses associated with the profile. The email collection can also include any preferences and consents associated with it.
Show child attributes
A collection of phone numbers associated with the profile. The phone number collection can also include any preferences and consents associated with it.
Show child attributes
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.
Show child attributes
Read-Only Id associated with the Profile.
Defines whether the item is Active or Inactive.
Read-only system fields returned as part of an API response. These are updated automatically when a profile is created or modified.
Show child attributes
An optional field for clients to use at their discretion to accommodate scenarios in which customer profile verification is performed.
An identifier used to classify a person by the type of customer. For example: Retail, Commercial, or Marketing.
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.
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.
Name fields associated with the profile.
Show child attributes
Default Locale for the profile.
Read-Only field. 'Complete' if the record has been processed otherwise 'Pending Update'.
An optional parameter that can be passed when deactivating a profile.
Collection of AlternateIds associated with the profile.
Show child attributes
What made this section unhelpful for you?
Response
{
"Consents": [
{
"ConsentType": "sample string 1",
"ConsentVersion": "sample string 2",
"Locale": "en_US",
"ConsentStatus": 2,
"ReasonCode": "sample string 3",
"ConsentDate": "sample string 4",
"ExpirationDate": "sample string 5",
"Expired": true,
"SourceId": "sample string 6",
"Attributes": [
{
"Key": "string",
"Value": "string"
}
],
"Edited": {
"CreateDate": "sample string 1",
"CreatedBy": "sample string 2",
"ModifiedDate": "sample string 3",
"ModifiedBy": "sample string 4"
},
"UpdatedVersionPending": true,
"IsActive": true
}
],
"CustomFields": [
{
"Name": "sample string 1",
"Value": "sample string 2",
"IsActive": true,
"Edited": {
"CreateDate": "sample string 1",
"CreatedBy": "sample string 2",
"ModifiedDate": "sample string 3",
"ModifiedBy": "sample string 4"
}
}
],
"Groups": [
{
"GroupType": "sample string 1",
"IsPrimary": true,
"GroupName": "sample string 2",
"IsActive": true,
"Edited": {
"CreateDate": "sample string 1",
"CreatedBy": "sample string 2",
"ModifiedDate": "sample string 3",
"ModifiedBy": "sample string 4"
}
}
],
"ProfileTags": [
{
"Name": "1"
}
],
"Addresses": [
{
"AddressType": "sample string 1",
"IsActive": true,
"IsDefault": true,
"Consents": [
{
"ConsentType": "sample string 1",
"ConsentVersion": "sample string 2",
"Locale": "en_US",
"ConsentStatus": 2,
"ReasonCode": "sample string 3",
"ConsentDate": "sample string 4",
"ExpirationDate": "sample string 5",
"Expired": true,
"SourceId": "sample string 6",
"Attributes": [
{
"Key": "string",
"Value": "string"
}
],
"Edited": {
"CreateDate": "sample string 1",
"CreatedBy": "sample string 2",
"ModifiedDate": "sample string 3",
"ModifiedBy": "sample string 4"
},
"UpdatedVersionPending": true,
"IsActive": true
}
],
"CassAddress1": "sample string 1",
"CassAddress2": "sample string 2",
"CassCity": "sample string 3",
"CassStateProvince": "sample string 4",
"CassPostalCode": "sample string 5",
"CassStatus": "sample string 6",
"Country": "sample string 7",
"Edited": {
"CreateDate": "sample string 1",
"CreatedBy": "sample string 2",
"ModifiedDate": "sample string 3",
"ModifiedBy": "sample string 4"
},
"Address1": "sample string 18",
"Address2": "sample string 19",
"City": "sample string 20",
"StateProvince": "sample string 21",
"CountryCode_Numeric": "222",
"CountryCode_Alpha2": "US",
"CountryCode_Alpha3": "121",
"PostalCode": "sample string 22",
"MissingRequiredConsents": false
}
],
"Emails": [
{
"EmailPreferences": [
{
"ProgramId": "sample string 1",
"ChannelId": "sample string 2",
"ConsentAssociations": [
{
"ConsentType": "sample string 1",
"ConsentVersion": "sample string 2",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "sample string 3",
"UpdatedVersionPending": false
}
],
"MatchType": "sample string 3",
"ReasonCode": "sample string 4",
"ExpirationDate": "sample string 5",
"PreferenceStatus": "sample string 6",
"LastModifiedDate": "sample string 7",
"UserId": "sample string 8",
"SourceId": "sample string 9",
"FilterId": "sample string 10",
"PreferenceType": 2,
"FrequencyId": "sample string 11",
"Attributes": [
{
"Key": "sample string 1",
"Value": "sample string 2"
}
],
"CustomerDate": "sample string 12"
}
],
"EmailAddressType": "sample string 1",
"EmailAddress": "sample string 2",
"IsDefault": true,
"Consents": [
{
"ConsentType": "sample string 1",
"ConsentVersion": "sample string 2",
"Locale": "en_US",
"ConsentStatus": 2,
"ReasonCode": "sample string 3",
"ConsentDate": "sample string 4",
"ExpirationDate": "sample string 5",
"Expired": true,
"SourceId": "sample string 6",
"Attributes": [
{
"Key": "string",
"Value": "string"
}
],
"Edited": {
"CreateDate": "sample string 1",
"CreatedBy": "sample string 2",
"ModifiedDate": "sample string 3",
"ModifiedBy": "sample string 4"
},
"UpdatedVersionPending": true,
"IsActive": true
}
],
"IsActive": true,
"Edited": {
"CreateDate": "sample string 1",
"CreatedBy": "sample string 2",
"ModifiedDate": "sample string 3",
"ModifiedBy": "sample string 4"
},
"MissingRequiredConsents": false
}
],
"PhoneNumbers": [
{
"PhonePreferences": [
{
"ProgramId": "sample string 1",
"ChannelId": "sample string 2",
"ConsentAssociations": [
{
"ConsentType": "sample string 1",
"ConsentVersion": "sample string 2",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "sample string 3",
"UpdatedVersionPending": false
}
],
"MatchType": "sample string 3",
"ReasonCode": "sample string 4",
"ExpirationDate": "sample string 5",
"PreferenceStatus": "sample string 6",
"LastModifiedDate": "sample string 7",
"UserId": "sample string 8",
"SourceId": "sample string 9",
"FilterId": "sample string 10",
"PreferenceType": 2,
"FrequencyId": "sample string 11",
"Attributes": [
{
"Key": "sample string 1",
"Value": "sample string 2"
}
],
"CustomerDate": "sample string 12",
"MissingRequiredConsents": false
}
],
"PhoneType": "sample string 1",
"PhoneNumber": "sample string 2",
"PhoneNumberNumeric": 1,
"IsDefault": true,
"Consents": [
{
"ConsentType": "sample string 1",
"ConsentVersion": "sample string 2",
"Locale": "en_US",
"ConsentStatus": 2,
"ReasonCode": "sample string 3",
"ConsentDate": "sample string 4",
"ExpirationDate": "sample string 5",
"Expired": true,
"SourceId": "sample string 6",
"Attributes": [
{
"Key": "string",
"Value": "string"
}
],
"Edited": {
"CreateDate": "sample string 1",
"CreatedBy": "sample string 2",
"ModifiedDate": "sample string 3",
"ModifiedBy": "sample string 4"
},
"UpdatedVersionPending": true,
"IsActive": true
}
],
"IsMobile": false,
"IsActive": true,
"Edited": {
"CreateDate": "sample string 1",
"CreatedBy": "sample string 2",
"ModifiedDate": "sample string 3",
"ModifiedBy": "sample string 4"
},
"MissingRequiredConsents": false
}
],
"ProfilePreferences": [
{
"ProgramId": "sample string 1",
"ChannelId": "sample string 2",
"ConsentAssociations": [
{
"ConsentType": "sample string 1",
"ConsentVersion": "sample string 2",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "sample string 3",
"UpdatedVersionPending": false
}
],
"MatchType": "sample string 3",
"ReasonCode": "sample string 4",
"ExpirationDate": "sample string 5",
"PreferenceStatus": "sample string 6",
"LastModifiedDate": "sample string 7",
"UserId": "sample string 8",
"SourceId": "sample string 9",
"FilterId": "sample string 10",
"PreferenceType": 2,
"FrequencyId": "sample string 11",
"Attributes": [
{
"Key": "sample string 1",
"Value": "sample string 2"
}
],
"CustomerDate": "sample string 12",
"MissingRequiredConsents": false
}
],
"ProfileId": 1,
"IsActive": true,
"Edited": {
"CreateDate": "sample string 1",
"CreatedBy": "sample string 2",
"ModifiedDate": "sample string 3",
"ModifiedBy": "sample string 4"
},
"RegistrationConfirmed": true,
"CustomerType": "sample string 1",
"PreserveConsents": true,
"PreservePreferences": true,
"CustomerName": {
"FirstName": "sample string 1",
"MiddleName": "sample string 2",
"LastName": "sample string 3",
"Prefix": "",
"Suffix": "sample string 4"
},
"DefaultLocale": "sample string 2",
"UpdateStatus": "sample string 3",
"ReasonCode": "sample string 4",
"AlternateIds": [
{
"AlternateIdType": "sample string 1",
"AlternateId": "sample string 2",
"IsActive": true,
"Edited": {
"CreateDate": "",
"CreatedBy": "",
"ModifiedDate": "",
"ModifiedBy": ""
},
"AlternateIdTypeLink": 1
}
]
}What made this section unhelpful for you?
Update profile by alternate id (POST)
This method is used for inserting and updating a profile using the provided alternate ID and alternateIdType in the request. If the combination of AlternateId and AlternateId Type 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 alternateId and alternateIdType, the method will perform an insert operation to create a new profile.
Header Parameters
Authorization token
Query Parameters
This is the value that uniquely identifies the profile that is being retrieved.
Value that identifies the type of alternate id that is being accessed.
Path Parameters
This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.
Body Parameters
System-generated unique identifier associated with the profile. Read-only.
Defines whether the item is active or inactive.
Read-only system fields returned as part of an API response. These are updated automatically when a profile is created or modified.
Show child attributes
An optional field for clients to use at their discretion to accommodate scenarios in which customer profile verification is performed.
An identifier used to classify a person based on specific criteria. For example, it can represent their buying stage (prospect, lead, customer), firmographics (industry, company size), or any other criteria.
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.
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.
Name fields associated with the profile.
Show child attributes
Default Locale for the profile.
Shows 'Complete' if the record is processed, otherwise 'Pending Update.' Read-only.
An optional parameter used when deactivating a profile to specify the reason for deactivation.
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.
Show child attributes
A collection of mailing addresses associated with the profile. The address collection can also include any preferences and consents associated with it.
Show child attributes
A collection of email addresses associated with the profile. The email collection can also include any preferences and consents associated with it.
Show child attributes
A collection of phone numbers associated with the profile. The phone number collection can also include any preferences and consents associated with it.
Show child attributes
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.
Show child attributes
A collection of consents associated with the profile.
Show child attributes
A collection of custom fields associated with the profile.
Show child attributes
A collection of Groups associated with the profile.
Show child attributes
A collection of Tags associated with the profile.
Show child attributes
Response
Response Attributes
What made this section unhelpful for you?
Response
{
"AlternateId": "49594318543",
"AlternateIdType": "Facebook",
"ProfileId": 2716778,
"UpdateStatus": "Pending Update",
"SubmittedUtcTime": "2024-08-16T19:26:10.126Z"
}What made this section unhelpful for you?
Update profile by alternate id (PUT)
By using this method, you can completely replace a profile by matching on the alternateId and alternateIdType 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.
Header Parameters
Authorization token
Query Parameters
Alternate Id value that uniquely identifies the profile that is being retrieved.
Name of the Alternate Id type associated with the specified Alternate Id.
Path Parameters
This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.
Body Parameters
System-generated unique identifier associated with the profile. Read-only.
Defines whether the item is active or inactive.
Read-only system fields returned as part of an API response. These are updated automatically when a profile is created or modified.
Show child attributes
An optional field for clients to use at their discretion to accommodate scenarios in which customer profile verification is performed.
An identifier used to classify a person based on specific criteria. For example, it can represent their buying stage (prospect, lead, customer), firmographics (industry, company size), or any other criteria.
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.
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.
Name fields associated with the profile.
Show child attributes
Default Locale for the profile.
Shows 'Complete' if the record is processed, otherwise 'Pending Update.' Read-only.
An optional parameter used when deactivating a profile to specify the reason for deactivation.
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.
Show child attributes
A collection of mailing addresses associated with the profile. The address collection can also include any preferences and consents associated with it.
Show child attributes
A collection of email addresses associated with the profile. The email collection can also include any preferences and consents associated with it.
Show child attributes
A collection of phone numbers associated with the profile. The phone number collection can also include any preferences and consents associated with it.
Show child attributes
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.
Show child attributes
A collection of consents associated with the profile.
Show child attributes
A collection of custom fields associated with the profile.
Show child attributes
A collection of Groups associated with the profile.
Show child attributes
A collection of Tags associated with the profile.
Show child attributes
Response
Response Attributes
System-generated unique identifier associated with the profile. Read-only.
Defines whether the item is active or inactive.
Read-only system fields returned as part of an API response. These are updated automatically when a profile is created or modified.
Show child attributes
An optional field for clients to use at their discretion to accommodate scenarios in which customer profile verification is performed.
An identifier used to classify a person based on specific criteria. For example, it can represent their buying stage (prospect, lead, customer), firmographics (industry, company size), or any other criteria.
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.
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.
Name fields associated with the profile.
Show child attributes
Default Locale for the profile.
Shows 'Complete' if the record is processed, otherwise 'Pending Update.' Read-only.
An optional parameter used when deactivating a profile to specify the reason for deactivation.
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.
Show child attributes
A collection of mailing addresses associated with the profile. The address collection can also include any preferences and consents associated with it.
Show child attributes
A collection of email addresses associated with the profile. The email collection can also include any preferences and consents associated with it.
Show child attributes
A collection of phone numbers associated with the profile. The phone number collection can also include any preferences and consents associated with it.
Show child attributes
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.
Show child attributes
A collection of consents associated with the profile.
Show child attributes
A collection of custom fields associated with the profile.
Show child attributes
A collection of Groups associated with the profile.
Show child attributes
A collection of Tags associated with the profile.
Show child attributes
What made this section unhelpful for you?
Response
{
"ProfileId": 27178,
"IsActive": true,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"RegistrationConfirmed": true,
"CustomerType": "Lead",
"PreserveConsents": true,
"PreservePreferences": true,
"CustomerName": {
"FirstName": "John",
"MiddleName": "F",
"LastName": "Doe",
"Prefix": "Mr",
"Suffix": "Jr"
},
"DefaultLocale": "en_US",
"UpdateStatus": "Complete",
"ReasonCode": "",
"AlternateIds": [
{
"AlternateIdType": "Salesforce ContactId",
"AlternateId": "0031njkASSIs2kk909",
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
}
}
],
"Addresses": [
{
"Address1": "4400 River Green Parkway",
"Address2": "Suite 100",
"City": "Duluth",
"StateProvince": "GA",
"CountryCode_Numeric": "840",
"CountryCode_Alpha2": "US",
"CountryCode_Alpha3": "USA",
"PostalCode": "30096-2549",
"AddressType": "Work",
"IsActive": true,
"IsDefault": false,
"CassAddress1": "4400 RIVER GREEN PKWY",
"CassAddress2": "",
"CassCity": "DULUTH",
"CassStateProvince": "GA",
"CassPostalCode": "30096-2531",
"CassStatus": "Y",
"Country": "United States of America",
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"MissingRequiredConsents": false,
"Consents": [
{
"ConsentType": "Direct Mail Consent",
"ConsentVersion": "v1.0",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2024-10-25T13:50:40.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Lead Gen Form - 221",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2024-02-09T22:09:08.430Z",
"CreatedBy": "John.Doe",
"ModifiedDate": "2024-02-22T22:09:08.430Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
]
}
],
"AddressPreferences": [
{
"ProgramId": "in_banking_alert",
"ChannelId": "Mail",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-09-14T20:18:56.943Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_mail",
"PreferenceType": "2",
"FrequencyId": "MONTHLY",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2022-05-03T20:21:48.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": false,
"ConsentAssociations": [
{
"ConsentType": "Opt-in Consent",
"ConsentVersion": "v1",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
]
}
],
"Emails": [
{
"EmailAddressType": "Primary",
"EmailAddress": "john.doe@example.com",
"IsDefault": false,
"Consents": [
{
"ConsentType": "Global Email Marketing Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:50:40.000Z",
"ExpirationDate": "2022-10-25T13:50:40.000Z",
"Expired": true,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"EmailPreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Email",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2023-01-09T14:26:45.280Z",
"UserId": "Trust Center",
"SourceId": "Default",
"FilterId": "fin_banking_email",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "Nurture-11"
}
],
"CustomerDate": "2023-01-09T14:26:41.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": false,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false,
"IsActive": false,
"Edited": {
"CreateDate": "2022-10-25T13:50:43.220Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Privacy Portal"
}
}
],
"PhoneNumbers": [
{
"PhoneType": "Home",
"PhoneNumber": "7702551021",
"PhoneNumberNumeric": 7702551021,
"IsDefault": false,
"Consents": [
{
"ConsentType": "TCPA Landline Consent",
"ConsentVersion": "v1",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2023-11-02T21:23:31.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Service App",
"UpdatedVersionPending": false,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T21:23:37.023Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-21T18:25:42.467Z",
"ModifiedBy": "Agent ID - 1334"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "USA"
}
]
}
],
"IsMobile": false,
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2024-02-10T13:48:18.943Z",
"ModifiedBy": "My Accounts Page"
},
"PhonePreferences": [
{
"ProgramId": "fin_banking_alert",
"ChannelId": "Phone",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-02-10T13:48:18.943Z",
"UserId": "App_Preferences_Widget_SC22",
"SourceId": "In-app Widgets",
"FilterId": "fin_banking_phone",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "campaign_ID",
"Value": "CMC 123"
}
],
"CustomerDate": "2024-02-10T13:48:13.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"MissingRequiredConsents": false
}
],
"ProfilePreferences": [
{
"ProgramId": "ins_payment_confirmation",
"ChannelId": "Solicit",
"MatchType": "Expressed",
"ReasonCode": "",
"ExpirationDate": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2021-11-17T18:44:21.707Z",
"UserId": "My Accounts Page",
"SourceId": "Default",
"FilterId": "ins_payment_app_notify",
"PreferenceType": "1",
"FrequencyId": "Immediate",
"Attributes": [
{
"Key": "App Id",
"Value": "JADKYK13343KD"
}
],
"CustomerDate": "2023-11-17T18:44:12.000Z",
"DropReasonNbr": null,
"MissingRequiredConsents": false,
"IsActive": true,
"ConsentAssociations": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "v5",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "",
"UpdatedVersionPending": false
}
]
}
],
"Consents": [
{
"ConsentType": "CCPA Privacy Rights",
"ConsentVersion": "v4",
"Locale": "en_US",
"ConsentStatus": 1,
"ReasonCode": "",
"ConsentDate": "2022-10-25T13:28:49.000Z",
"ExpirationDate": "",
"Expired": false,
"SourceId": "Default",
"UpdatedVersionPending": false,
"IsActive": false,
"Edited": {
"CreateDate": "2021-11-16T20:42:08.633Z",
"CreatedBy": "Web App",
"ModifiedDate": "2022-10-25T13:28:51.343Z",
"ModifiedBy": "Web App"
},
"Attributes": [
{
"Key": "Applicable Jurisdiction",
"Value": "CA-USA"
}
]
}
],
"CustomFields": [
{
"Name": "Interests",
"Value": "Shopping::Camping and Outdoors::Online Gaming",
"IsActive": true,
"Edited": {
"CreateDate": "2022-05-03T20:21:21.347Z",
"CreatedBy": "Web App",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"Groups": [
{
"GroupType": "Household",
"GroupName": "Family",
"IsPrimary": true,
"IsActive": true,
"Edited": {
"CreateDate": "2023-11-02T15:29:15.973Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2023-11-01T23:50:50.700Z",
"ModifiedBy": "Web App"
}
}
],
"ProfileTags": [
{
"Name": "Frequent Customer"
}
]
}What made this section unhelpful for you?
Update profile by alternate id (PATCH))
This method allows for partial modifications to be applied to a specific profile using the combination of the alternateId and alternateIdType 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 here 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.
Header Parameters
Authorization token
Query Parameters
Alternate Id value that uniquely identifies the profile that is being retrieved.
Name of the Alternate Id type associated with the specified Alternate Id.
Path Parameters
This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.
Body Parameters
A collection of PATCH operations that you want to perform on the object.
Show child attributes
Response
Response Attributes
A collection of consents associated with the User Profile.
Show child attributes
A collection of Custom Fields associated with the profile.
Show child attributes
A collection of Groups associated with the profile.
Show child attributes
A collection of Tags associated with the profile.
Show child attributes
Collection of addresses associated with the profile.
Show child attributes
A collection of email addresses associated with the profile. The email collection can also include any preferences and consents associated with it.
Show child attributes
A collection of phone numbers associated with the profile. The phone number collection can also include any preferences and consents associated with it.
Show child attributes
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.
Show child attributes
Read-Only Id associated with the Profile.
Defines whether the item is Active or Inactive.
Read-only system fields returned as part of an API response. These are updated automatically when a profile is created or modified.
Show child attributes
An optional field for clients to use at their discretion to accommodate scenarios in which customer profile verification is performed.
An identifier used to classify a person by the type of customer. For example: Retail, Commercial, or Marketing.
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.
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.
Name fields associated with the profile.
Show child attributes
Default Locale for the profile.
Read-Only field. 'Complete' if the record has been processed otherwise 'Pending Update'.
An optional parameter that can be passed when deactivating a profile.
Collection of AlternateIds associated with the profile.
Show child attributes
What made this section unhelpful for you?
Response
{
"Consents": [
{
"ConsentType": "sample string 1",
"ConsentVersion": "sample string 2",
"Locale": "en_US",
"ConsentStatus": 2,
"ReasonCode": "sample string 3",
"ConsentDate": "sample string 4",
"ExpirationDate": "sample string 5",
"Expired": true,
"SourceId": "sample string 6",
"Attributes": [
{
"Key": "string",
"Value": "string"
}
],
"Edited": {
"CreateDate": "sample string 1",
"CreatedBy": "sample string 2",
"ModifiedDate": "sample string 3",
"ModifiedBy": "sample string 4"
},
"UpdatedVersionPending": true,
"IsActive": true
}
],
"CustomFields": [
{
"Name": "sample string 1",
"Value": "sample string 2",
"IsActive": true,
"Edited": {
"CreateDate": "sample string 1",
"CreatedBy": "sample string 2",
"ModifiedDate": "sample string 3",
"ModifiedBy": "sample string 4"
}
}
],
"Groups": [
{
"GroupType": "sample string 1",
"IsPrimary": true,
"GroupName": "sample string 2",
"IsActive": true,
"Edited": {
"CreateDate": "sample string 1",
"CreatedBy": "sample string 2",
"ModifiedDate": "sample string 3",
"ModifiedBy": "sample string 4"
}
}
],
"ProfileTags": [
{
"Name": "1"
}
],
"Addresses": [
{
"AddressType": "sample string 1",
"IsActive": true,
"IsDefault": true,
"Consents": [
{
"ConsentType": "sample string 1",
"ConsentVersion": "sample string 2",
"Locale": "en_US",
"ConsentStatus": 2,
"ReasonCode": "sample string 3",
"ConsentDate": "sample string 4",
"ExpirationDate": "sample string 5",
"Expired": true,
"SourceId": "sample string 6",
"Attributes": [
{
"Key": "string",
"Value": "string"
}
],
"Edited": {
"CreateDate": "sample string 1",
"CreatedBy": "sample string 2",
"ModifiedDate": "sample string 3",
"ModifiedBy": "sample string 4"
},
"UpdatedVersionPending": true,
"IsActive": true
}
],
"CassAddress1": "sample string 1",
"CassAddress2": "sample string 2",
"CassCity": "sample string 3",
"CassStateProvince": "sample string 4",
"CassPostalCode": "sample string 5",
"CassStatus": "sample string 6",
"Country": "sample string 7",
"Edited": {
"CreateDate": "sample string 1",
"CreatedBy": "sample string 2",
"ModifiedDate": "sample string 3",
"ModifiedBy": "sample string 4"
},
"Address1": "sample string 18",
"Address2": "sample string 19",
"City": "sample string 20",
"StateProvince": "sample string 21",
"CountryCode_Numeric": "222",
"CountryCode_Alpha2": "US",
"CountryCode_Alpha3": "121",
"PostalCode": "sample string 22",
"MissingRequiredConsents": false
}
],
"Emails": [
{
"EmailPreferences": [
{
"ProgramId": "sample string 1",
"ChannelId": "sample string 2",
"ConsentAssociations": [
{
"ConsentType": "sample string 1",
"ConsentVersion": "sample string 2",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "sample string 3",
"UpdatedVersionPending": false
}
],
"MatchType": "sample string 3",
"ReasonCode": "sample string 4",
"ExpirationDate": "sample string 5",
"PreferenceStatus": "sample string 6",
"LastModifiedDate": "sample string 7",
"UserId": "sample string 8",
"SourceId": "sample string 9",
"FilterId": "sample string 10",
"PreferenceType": 2,
"FrequencyId": "sample string 11",
"Attributes": [
{
"Key": "sample string 1",
"Value": "sample string 2"
}
],
"CustomerDate": "sample string 12"
}
],
"EmailAddressType": "sample string 1",
"EmailAddress": "sample string 2",
"IsDefault": true,
"Consents": [
{
"ConsentType": "sample string 1",
"ConsentVersion": "sample string 2",
"Locale": "en_US",
"ConsentStatus": 2,
"ReasonCode": "sample string 3",
"ConsentDate": "sample string 4",
"ExpirationDate": "sample string 5",
"Expired": true,
"SourceId": "sample string 6",
"Attributes": [
{
"Key": "string",
"Value": "string"
}
],
"Edited": {
"CreateDate": "sample string 1",
"CreatedBy": "sample string 2",
"ModifiedDate": "sample string 3",
"ModifiedBy": "sample string 4"
},
"UpdatedVersionPending": true,
"IsActive": true
}
],
"IsActive": true,
"Edited": {
"CreateDate": "sample string 1",
"CreatedBy": "sample string 2",
"ModifiedDate": "sample string 3",
"ModifiedBy": "sample string 4"
},
"MissingRequiredConsents": false
}
],
"PhoneNumbers": [
{
"PhonePreferences": [
{
"ProgramId": "sample string 1",
"ChannelId": "sample string 2",
"ConsentAssociations": [
{
"ConsentType": "sample string 1",
"ConsentVersion": "sample string 2",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "sample string 3",
"UpdatedVersionPending": false
}
],
"MatchType": "sample string 3",
"ReasonCode": "sample string 4",
"ExpirationDate": "sample string 5",
"PreferenceStatus": "sample string 6",
"LastModifiedDate": "sample string 7",
"UserId": "sample string 8",
"SourceId": "sample string 9",
"FilterId": "sample string 10",
"PreferenceType": 2,
"FrequencyId": "sample string 11",
"Attributes": [
{
"Key": "sample string 1",
"Value": "sample string 2"
}
],
"CustomerDate": "sample string 12",
"MissingRequiredConsents": false
}
],
"PhoneType": "sample string 1",
"PhoneNumber": "sample string 2",
"PhoneNumberNumeric": 1,
"IsDefault": true,
"Consents": [
{
"ConsentType": "sample string 1",
"ConsentVersion": "sample string 2",
"Locale": "en_US",
"ConsentStatus": 2,
"ReasonCode": "sample string 3",
"ConsentDate": "sample string 4",
"ExpirationDate": "sample string 5",
"Expired": true,
"SourceId": "sample string 6",
"Attributes": [
{
"Key": "string",
"Value": "string"
}
],
"Edited": {
"CreateDate": "sample string 1",
"CreatedBy": "sample string 2",
"ModifiedDate": "sample string 3",
"ModifiedBy": "sample string 4"
},
"UpdatedVersionPending": true,
"IsActive": true
}
],
"IsMobile": false,
"IsActive": true,
"Edited": {
"CreateDate": "sample string 1",
"CreatedBy": "sample string 2",
"ModifiedDate": "sample string 3",
"ModifiedBy": "sample string 4"
},
"MissingRequiredConsents": false
}
],
"ProfilePreferences": [
{
"ProgramId": "sample string 1",
"ChannelId": "sample string 2",
"ConsentAssociations": [
{
"ConsentType": "sample string 1",
"ConsentVersion": "sample string 2",
"IsActive": true,
"Locale": "en_US",
"ReasonCode": "sample string 3",
"UpdatedVersionPending": false
}
],
"MatchType": "sample string 3",
"ReasonCode": "sample string 4",
"ExpirationDate": "sample string 5",
"PreferenceStatus": "sample string 6",
"LastModifiedDate": "sample string 7",
"UserId": "sample string 8",
"SourceId": "sample string 9",
"FilterId": "sample string 10",
"PreferenceType": 2,
"FrequencyId": "sample string 11",
"Attributes": [
{
"Key": "sample string 1",
"Value": "sample string 2"
}
],
"CustomerDate": "sample string 12",
"MissingRequiredConsents": false
}
],
"ProfileId": 1,
"IsActive": true,
"Edited": {
"CreateDate": "sample string 1",
"CreatedBy": "sample string 2",
"ModifiedDate": "sample string 3",
"ModifiedBy": "sample string 4"
},
"RegistrationConfirmed": true,
"CustomerType": "sample string 1",
"PreserveConsents": true,
"PreservePreferences": true,
"CustomerName": {
"FirstName": "sample string 1",
"MiddleName": "sample string 2",
"LastName": "sample string 3",
"Prefix": "",
"Suffix": "sample string 4"
},
"DefaultLocale": "sample string 2",
"UpdateStatus": "sample string 3",
"ReasonCode": "sample string 4",
"AlternateIds": [
{
"AlternateIdType": "sample string 1",
"AlternateId": "sample string 2",
"IsActive": true,
"Edited": {
"CreateDate": "",
"CreatedBy": "",
"ModifiedDate": "",
"ModifiedBy": ""
},
"AlternateIdTypeLink": 1
}
]
}What made this section unhelpful for you?
Archive preferences
This method allows you to deactivate preferences on a profile across one or more Filters. You can deactivate preferences that are simply tied to the profile or preferences that are associated with contact elements.
To deactivate all preferences across all filters on a profile, simply set the GlobalDeactivate parameter to true. Deactivated preferences are archived and are no longer returned via the MyPreferences API.
You can create a segment to retrieve archived preferences using the MyPreferences Bulk Export API.
Header Parameters
Authorization token
Path Parameters
This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.
Id associated with the profile.
Body Parameters
If set to true, deactivates and archives all preferences associated with the Profile and all its contact elements.
Optional parameter that can be used to store the reason for deactivation.
A collection of phone preferences associated with the User Profile that you want to deactivate. All deactivated phone preferences are archived.
Show child attributes
Collection of addresses associated with the profile.
Show child attributes
A collection of email preferences associated with the User Profile that you want to deactivate. All deactivated email preferences are archived.
Show child attributes
A collection of preferences associated with the User Profile that you want to deactivate. All deactivated profile preferences are archived.
Show child attributes
Response
What made this section unhelpful for you?
Response
What made this section unhelpful for you?
Delete profile
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.
Header Parameters
Authorization token
Query Parameters
An optional parameter that can be used to store the reason for deletion.
Path Parameters
This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.
System generated unique identifier of the profile.
Response
What made this section unhelpful for you?
Response
The request was successfully processed but there is no content to return.What made this section unhelpful for you?
Historical API's
Providing historical access to customer data is one of the hallmarks of MyPreferences. Through our comprehensive historical API library, you gain valuable insights into the evolution of customer preferences, consents, contact element changes, and both standard and custom field updates over time.
Accessing this wealth of historical data is simple. You can effortlessly retrieve the history for any entity by either utilizing the profileId or an alternateId associated with the profile.
Retrieving Contacts History
The historical API's for retrieving contact history returns the current contact element along with all historical contact elements associated with each active Type on the profile. Consents associated with the contact elements are also returned. Along with the Profile ID, a collection of current Alternate IDs associated with the profile is also returned. Profile-only consents, custom fields, groups, tags, and preferences are not returned.
Retrieving Standard Fields History
Standard Fields allow you to collect basic profile information such as name, default language, registration confirmed status, and customer type. They also allow you to control the business rules around preserving preferences and consents, capturing reason code when deleting a profile, and the overall status of the profile.
The following list includes all the standard fields available in MyPreferences:
- Prefix
- First Name
- Middle Name
- Last Name
- Suffix
- Default Locale
- Registration Confirmed (applicable in use cases where customer profile verification is performed)
- Customer Type
- PreservePreferences
- PreserveConsents
- ReasonCode
- IsActive
The historical API's for retrieving standard field history offers a historical view of all standard field changes that happened over time on a user’s profile. You can retrieve the standard fields history by Profile ID or an Alternate ID associated with the profile.
Integration API
The Integration API 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.
Bulk API
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 personalized experiences to your customers.
Events API
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.
Base URL
Production:
https://pm.mypreferences.com/Profiles/v4
Sandbox:
https://pmstg.mypreferences.com/Profiles/v4