Create profile

Authorization token

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

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.

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.

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.

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

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

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

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.

A collection of consents associated with the profile.

A collection of custom fields associated with the profile.

A collection of Groups associated with the profile.

A collection of Tags associated with the profile.

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.