Update event subscription
Use this method to update an event subscription.
You can make the following updates to the event subscription:
- Event types - Add or remove events that you have subscribed to.
- Notification methods - Update information about your endpoint and who we email if we can’t contact your endpoint.
Include the subscriptionId that we sent you when you created the event subscription. We returned this in the id field.
Note: If you don’t know the subscriptionId, go to List event subscriptions
Path parameters
subscriptionId
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
This endpoint expects an object.
enabled
Indicates if we should notify you if 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.
eventTypes
Array of eventTypes that you want to subscribe to. For a list of all events that you can subscribe to, go to Events.
notifications
Array of notifications, which includes information about how we contact you when an event occurs.
metadata
Object that you can send to include custom data in the request. For more information about how to use metadata, go to Metadata.