SchemaEvent Subscriptions

Partially update event subscription

Use this method to partially update an event subscription. You can make the following updates to the event subscription:

  • Add or remove events that you have subscribed to.
  • Update information about your endpoint and who we email if we can’t contact your endpoint.
  • Turn on or turn off notifications for the event.

Structure your request to follow the RFC 6902 standard.

Note: You need the subscriptionId that we sent you when you created the event subscription. If you don’t know the subscriptionId, go to List event subscriptions.

Path parameters

subscriptionIdstringRequired

Headers

AuthorizationstringRequired

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

Request

This endpoint expects a list of objects.
Patch Add OperationobjectRequired
OR
Patch Remove OperationobjectRequired
OR
Patch Replace OperationobjectRequired
OR
Patch Move OperationobjectRequired
OR
Patch Copy OperationobjectRequired
OR
Patch Test OperationobjectRequired

Response

Successful request. We updated the event subscription.

enabledboolean

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 strings

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 objects

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

iddoubleOptional

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.

Errors