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.