increase-test
PATCH/event_subscriptions/{event_subscription_id}

Update an event subscription

Updates the status of an event subscription. Set status to active, disabled, or deleted to control whether the subscription receives notifications.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
event_subscription_idstringrequired
The identifier of the event subscription to update.

The event subscription status to set.

statusstringoptional
The status to update the Event Subscription with.
Allowed:activedisableddeleted

3 status codes
200Returns the updated event subscription, including its identifier, status, webhook URL, selected event categories, and creation time.
created_atstringrequired
The time the event subscription was created.
idstringrequired
The event subscription identifier.
idempotency_keystringrequired
The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).
oauth_connection_idstringrequired
If specified, this subscription will only receive webhooks for Events associated with this OAuth Connection.
selected_event_categoriesarray<EventSubscriptionSelectedEventCategoriesElement>required
If specified, this subscription will only receive webhooks for Events with the specified `category`.
statusstringrequired
This indicates if we'll send notifications to this subscription.
Allowed:activedisableddeleted
typestringrequired
A constant representing the object's type. For this resource it will always be `event_subscription`.
Allowed:event_subscription
urlstringrequired
The webhook url where we'll send notifications.
4XXReturned when the request cannot be processed because of a client-side error.
5XXReturned when the service encounters a server-side error.

Error handling

The status field must be one of: active, disabled, or deleted. The event_subscription_id path parameter must identify an event subscription.