| Name | Description | Type | Additional information |
|---|---|---|---|
| ProfileId |
A read-only unique identifier associated with the Profile. It is auto generated by the system when a profile is created. |
integer |
Read-Only |
| Edited |
Read-only system fields returned as part of an API response. These are updated automatically when a profile is created or modified. |
EditInfo |
Read-Only |
| Addresses |
A collection of Mailing addresses associated with the profile. |
Collection of AddressEntry | |
| Consents |
A collection of consents associated with the profile. |
Collection of CustomerConsent |
Consents are not supported when creating a Profile. You must use the POST Consents endpoint to associate consents to a Profile Read-Only |
| ReasonCode |
An optional parameter that can be passed on the Deactivate Profile API to store the reason for deletion. |
string |
Max length: 256 Read-Only The Reason code field is supported only when deactivating a preference. It is not returned as part of this call |
| IsActive |
Defines whether the item is Active or Inactive. You can activate the profile using the Activate Profile API |
boolean |
You can activate the profile using the Activate Profile API. |
| RegistrationConfirmed |
An optional field for clients to use at their discretion to accommodate scenarios in which customer profile verification is performed. |
boolean |
This setting defaults to False, if not specified. |
| CustomerType |
An identifier used to classify a person. For example, a contact can be classified as a Customer or a Prospect. |
string |
If a Type is not provided, the available default Type will be associated with the Profile. Max length: 100 |
| PreservePreferences |
Specifies whether to retain the preferences or deactivate them when a Contact Type is deactivated. 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. |
boolean |
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. |
| DefaultLocale |
Default locale associated with the profile. If not specified, the default locale configured for your MyPreferences account will be used. |
string |
Max length: 15 |
| CustomerName |
The Name fields on the profile |
CustomerName | |
| AlternateIds |
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. |
Collection of AlternateIdEntry | |
| Emails |
A collection of Email addresses associated with the profile. |
Collection of EmailEntry | |
| PhoneNumbers |
A collection of Phone numbers associated with the profile. |
Collection of PhoneNumberEntry | |
| Groups |
A collection of Groups associated with the profile. |
Collection of GroupEntry | |
| ProfileTags |
A collection of Tags associated with the profile. |
Collection of Tag |
Tags help you organize your profiles based on specific pieces of information such as Influencers or Reward members. You can add and delete Tags without affecting the profile information. |
| CustomFields |
A collection of Custom Fields associated with the profile. |
Collection of CustomFieldValue |
Custom Fields helps you expand and enrich the collection of user profile data throughout the customer journey. |