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 existing profile data will be overwritten with the values provided in the request.
All matching is case-insensitive. Values for alternateId and alternateIdType fields are treated as case-insensitive. Alternate IDs that differ only by letter casing are considered the same.
It is important to note that properties and collections not included in the request are 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 updated. Matching is case-insensitive.
Name of the Alternate Id type associated with the specified Alternate Id. Matching is case-insensitive.
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.
Shows 'Complete' if the record is processed, otherwise 'Pending Update.' Read-only.
What made this section unhelpful for you?
Response
What made this section unhelpful for you?