SchemaEvent Subscriptions

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

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 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.
eventTypeslist of stringsRequired

Array of eventTypes that you want to subscribe to. For a list of all events that you can subscribe to, go to Events.

notificationslist of objectsRequired

Array of notifications, which includes information about how we contact you when an event occurs.

idintegerOptional

Unique identifier that we assigned to the event subscription.

statusenumOptional

Status of the subscription. We return one of the following values:

  • registered - You have set up the subscription, and we will notify you when an event occurs.
  • suspended - We have deactivated the event subscription, and we won’t notify you when an event occurs.
  • failed - We couldn’t contact your URI endpoint. We email the supportEmailAddress.
Allowed values:
metadataobjectOptional

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