SchemaNotificationsEvent Subscriptions

Update event subscription

Use this method to update the details of an event subscription.

To update an event subscription, you need its subscriptionId. Our gateway returned the subscriptionId in the response of the Create Event Subscription method.

Note: If you don’t have the subscriptionId, use our List Event Subscriptions method to search for the event subscription.

You can update the following details about an event subscription:

  • Status of the event subscription.
  • Events that you have subscribed to. For a list of events that you can subscribe to, go to Events list.
  • Information about how we contact you when an event occurs.

Path parameters

subscriptionIdstringRequired

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
enabledbooleanRequired

Indicates if we should notify you when the event occurs. The value is one of the following:

  • true - We notify you when the event occurs.
  • false - We don’t notify you when the event occurs.
eventTypeslist of stringsRequired

Array of events that you want to subscribe to. For a list of events, go to Events List.

notificationslist of objectsRequired
Array of notifications objects. Each object contains information about how we contact you when an event occurs.
metadataobjectOptional

Object that you can send to include custom data in the request. For more information about how to use metadata, go to Metadata.

Response

Successful request. We updated the event subscription.

Errors