Sign in
eventSubscriptions

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.
patch/event-subscriptions/{subscriptionId}

Path parameters

subscriptionIdinteger required

Unique identifier that we assigned to the event subscription.
Note: Our gateway returned the subscriptionId in the id field in the response of the Create Event Subscription method.

Headers

Authorizationstring required

Bearer authentication

Idempotency-Keystring uuid required

Unique identifier that you generate for each request. You must use the UUID v4 format for the identifier. For more information about the idempotency key, go to Idempotency.

Request body

Response

Successful request. We updated the event subscription.

idinteger

Unique identifier that we assigned to the event subscription.

enabledboolean required

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.
status'registered' | 'suspended' | 'failed'

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.
eventTypesstring[] required

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

metadataEventSubscriptionMetadata

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

Changes