Create new subscription
Header Parameters
Authorization token
Type of the data being sent in the request or the data that is expected in the response. Supports application/json.
Path Parameters
This is your organization’s MyPreferences account Id.
Body Parameters
Name of the subscription.
Description of the subscription.
LocaleId used to return localized name and description for the event.
URL associated with the subscription to receive POST requests for events. Only secure (htttps) URL's are supported
The status of the subscription whether it's active and sending notifications, paused, or inactive. If you don't specify a state with your request, the default state of "Paused" will be applied.
ActivePausedIf set to true, the event notifications will only include the main event information without any data associated with it. Receiving systems must retrieve the data by other means.
Indicates whether the webhook subscription is active or not. Deactivating a subscription will result in its deletion. Please deactivate a subscription only when you no longer wish to receive event notifications. If you wish to temporarily pause event notifications, you can achieve this by using the 'State' parameter and setting it to 'Paused'.
If set to true, the system delivers events generated during the paused period, up to a maximum of 15 days, prior to resumption.
Collection of event subscriptions. Check out subscription examples for various entities in the upper right corner.
Show child attributes
Type Name associated with an active AlternateId Type. If available, will be returned instead of the profileId.
Response
Response Attributes
System generated read-only value that uniquely identifies the webhook subscription.
Name of the webhook subscription.
Description of the webhook subscription
LocaleId used to return localized name and description for the event.
Url associated with the subscription to receive HTTP POST requests. Only HTTPS URL's are supported.
Collection of event subscriptions.
Show child attributes
The status of the subscription whether it's active and sending notifications, paused, or inactive.
If set to true, the event notifications will only include the main event information without any data associated with it. Receiving systems must retrieve the data by other means.
Indicates whether the webhook subscription is active or not.
Type Name associated with an active AlternateId Type. If available, will be returned instead of the profileId.
Tags
The object or resource associated with the event (e.g., Preference, Consent, Custom Field, etc.).
TagsThe specific type of event you are subscribing to (e.g., preference.added, customfield.updated)
Contacts
Contacts Show child attributes
Profile
ProfileActionsPreferences
PreferencesFilter ID's associated with the Filters you want to subscribe. When subscribing to all Filters, specify 'AllFilters'
Show child attributes
StandardFields
StandardFieldsConsents
ConsentsType Names of the Consents you want to subscribe. When subscribing to all Consents, specify 'AllConsents'
Show child attributes
Groups
GroupsNames of the Groups you want to subscribe. When subscribing to all Groups, specify 'AllGroups'
Show child attributes
CustomFields
CustomFieldsNames of the custom fields you want to subscribe. When subscribing to all custom fields, specify 'AllCustomFields'
Show child attributes
What made this section unhelpful for you?
Response
What made this section unhelpful for you?