Sign in

v66

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-042174421.1 MB
Event

Update event subscription

Update an event subscription.

patch/v1/event_subscriptions/{event_subscription_token}

Path parameters

event_subscription_tokenstring required

Request body

descriptionstring

Event subscription description.

disabledboolean

Whether the event subscription is active (false) or inactive (true).

event_typesEventType[]

Indicates types of events that will be sent to this subscription. If left blank, all types will be sent.

urlstring uri required

URL to which event webhooks will be sent. URL must be a valid HTTPS address.

Response

OK

descriptionstring required

A description of the subscription.

disabledboolean required

Whether the subscription is disabled.

event_typesEventType[] nullable
tokenstring required

Globally unique identifier.

urlstring uri required

Example response

{
  "token": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga1"
}