SchemaNotificationsEvent Subscriptions

Partially update event subscription

Use this method to partially update an event subscription. Structure your request to follow the RFC 6902 standard.

To update an event subscription, you need its subscriptionId. Our gateway returned the subscriptionId in the id field 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 subscription.

You can update the following properties of an event subscription:

  • eventTypes - Subscribe to new events or remove events that you are subscribed to.
  • notifications - Information about your endpoint and who we email if we can’t contact your endpoint.
  • enabled - Turn on or turn off notifications for the subscription.

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 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 strings

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

notificationslist of objects
Array of notifications objects. Each object contains information about how we contact you when an event occurs.
iddouble or null
Unique identifier that we assigned to the event subscription.
statusenum or null

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:
metadataobject or null

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

Errors