API explorerChangelog
Overview

Sections

API explorer
Changelog

Theme switcher

Update subscription

This method allows you to update an existing webhook subscription by specifying the subscriptionId as the path parameter in your request.

Deactivating a subscription by setting the IsActive property to false 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'.

Utilizing this method replaces the entire webhook subscription with the subscription details provided in your request. To ensure accurate updates, remember to incorporate all properties, including the subscriptions you intend to retain, within your PUT request. If any properties are omitted, they will be considered as empty during the subscription update process.

Header Parameters

Authorizationstring Required

Authorization token

Content-Typestring

Type of the data being sent in the request or the data that is expected in the response. Supports application/json.

Path Parameters

clientIdstring Required

This is your organization’s MyPreferences account Id.

subscriptionIdstring Required

Id of the webhook subscription you want to update.

Body Parameters

Namestring Required

Name of the subscription.

Descriptionstring

Description of the subscription.

LocaleIdstring

LocaleId used to return localized name and description for the event.

Urlstring Required

URL associated with the subscription to receive POST requests for events. Only secure (htttps) URL's are supported

Statestring

The status of the subscription whether it's active and sending notifications, paused, or inactive.

Enum values:
Active
The webhook subscription is currently enabled and delivering events to the configured endpoint.
Inactive
The webhook subscription is temporarily disabled and will not send any events until reactivated.
IsMinimizedboolean

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.

IsActiveboolean

Indicates whether the webhook subscription is active or not.

CatchUpOnResumeboolean

If set to true, the system delivers events generated during the paused period, up to a maximum of 15 days, prior to resumption.

Subscriptionsarray Required

Collection of event subscriptions.

AlternateIdTypestring

Type Name associated with an active AlternateId Type. If available, will be returned instead of the profileId.

Response

200
Object
The update request was successful.

Response Attributes

Namestring

Name of the webhook subscription.

Descriptionstring

Description of the webhook subscription

LocaleIdstring

LocaleId used to return localized name and description for the event.

Urlstring

Url associated with the subscription to receive HTTP POST requests. Only HTTPS URL's are supported.

Subscriptionsarray

Collection of event subscriptions.

Statestring

The status of the subscription whether it's active and sending notifications, paused, or inactive.

IsMinimizedstring

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.

IsActiveboolean

Indicates whether the webhook subscription is active or not.

AlternateIdTypestring

Type Name associated with an active AlternateId Type. If available, will be returned instead of the profileId.

400
Object
The request was invalid and cannot be processed. This may be a result of a malformed request. You must update the request before trying again.
401
Object
Authentication credentials are missing or incorrect. You must verify your ClientId, UserId, and Authorization Scheme before trying again.
403
Object
The authentication credentials were insufficient to grant access to the requested resource. In most cases, your user may not have the appropriate permissions to access the requested resource. Verify User Group permissions for your user before trying again.
404
Object
Not Found
200
Object
503
Object
The server encountered an unexpected condition that prevented it from fulfilling the request. Notify PossibleNOW Support if it’s a continuous occurrence.

Tags

Entitystring Required
Enum values:
Tags
EventTypestring

Contacts

Entitystring Required
Enum values:
Contacts
EventTypestring
ContactTypesarray

Show child attributes

Profile

Entitystring Required
Enum values:
ProfileActions
EventTypestring

Preferences

Entitystring Required
Enum values:
Preferences
EventTypestring
Filtersarray Required

Filter IDs of the Filters you want to subscribe. When subscribing to all Filters, specify 'AllFilters'

Min items
1

Show child attributes

StandardFields

Entitystring Required
Enum values:
StandardFields
EventTypestring

Consents

Entitystring Required
Enum values:
Consents
EventTypestring
ConsentTypesarray Required

Type Names of the Consents you want to subscribe. When subscribing to all Consents, specify 'AllConsents'

Min items
1

Show child attributes

Groups

Entitystring Required
Enum values:
Groups
EventTypestring
Groupsarray Required

Names of the Groups you want to subscribe. When subscribing to all Groups, specify 'AllGroups'

Min items
1

Show child attributes

CustomFields

Entitystring Required
Enum values:
CustomFields
EventTypestring
CustomFieldsarray Required

Names of the custom fields you want to subscribe. When subscribing to all custom fields, specify 'AllCustomFields'

Min items
1

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

1 2 3 4 { "Entity": "Tags", "EventType": "tag.added" }

PUT

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?