API explorerChangelog
Overview

Sections

Theme switcher

ProfileActions

Profile Created and Replaced: Subscribing to this event type provides you with the entire profile record whenever a new profile is created or an existing profile is replaced with updated information using the Update Profile method . This comprehensive payload contains all the fields associated with the profile as specified in the create or update request.

Profile Deactivated, Reactivated, and Deleted: For these events, you will receive a basic payload containing only the unique identifier (ProfileId or AlternateId) of the profile that has been deactivated or deleted. This minimalist approach ensures that you are informed of the action taken without unnecessary data overhead.

Profile Updated: Whenever any property on a profile is modified, such as last name, email address or a phone number, you will receive the profile.updated event indicating the update. This event will be in addition to any specific event to which you are subscribed. For example, if you subscribe to profile.updated and contacts.email.added events, you will receive two events respectively. Similar to deactivation and deletion events, the payload will consist of the profile ID along with basic event information.

The webhook system will produce only one profile.updated event per operation to minimize unnecessary notifications. For instance, if you execute a single API call to add or modify multiple fields on a profile, you'll receive events for individual updates according to your webhook subscriptions, but only one profile.updated event for the entire operation. This rule applies to all updates made through the Data API. Additionally, updates carried out by Status Manager on enabled accounts are also included in this process.

Profile Created: The profile.created event is triggered when a new profile is added.

Plain text

Profile Replaced: The profile.replaced event is only generated when a PUT operation is performed on a profile.

Plain text

Profile Deactivated: The profile.deactivated event is triggered when an existing profile is deactivated.

Plain text

Profile Reactivated: The profile.reactivated event is triggered when a deactivated profile is reactivated.

Plain text

Profile Deleted: The profile.deleted is triggered when a contact is permanently removed from MyPreferences. Subscribing to these events proves valuable in scenarios where there's a necessity to receive notifications regarding data erasure requests as mandated by regulations such as GDPR or other privacy policies. This allows you to maintain compliance and honor customer's request to permanently remove their personal data.

Plain text

Profile Updated: The profile.updated event is an informational event that's generated each time a profile is updated.

Plain text
Was this section helpful?

What made this section unhelpful for you?

On this page
  • ProfileActions