Update a stream subscription

Updates one or more fields on an existing subscription. Only the fields you include in the request body are changed — omitted fields are left as-is.

Common operations:

  • Change webhook URL: set webhookUrl to the new URL.
  • Remove webhook delivery: set webhookUrl to an empty string (subscription must have websocket enabled).
  • Pause delivery: set active to false. Pending webhooks are held until you resume.
  • Resume delivery: set active to true.
  • Change filters: set partyFilter and/or eventTypes. See the create endpoint for available event types.

At least one delivery method (webhook or websocket) must remain enabled after the update.

Language
Response
Click Try It! to start a request and see the response here!