Update a webhook subscription

Updates a webhook subscription in place; fields you omit keep their current values. Only description, event_trigger, event_trigger_filters, request_type, request_url, header_json, body_payload_type, body_payload_json and enabled are applied — any other key in the body is ignored, and a body with none of them is rejected with 400. The subscription's name cannot be changed with this call: name is ignored and webhook_name is rejected with 400. An ID that belongs to another account is answered with 404 and nothing is written. The response body is an empty object; read the subscription back to see its new state.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of the subscription to update.

Body Params
string
string | null

New free-text note.

string

New call event to fire on: New Call, Ringing, Call Answer, Call Hangup or Fax Content. Any other value is accepted but never fires.

event_trigger_filters
object | null

Object. Stored and returned but not applied when events are delivered.

string | null
enum

POST, PUT or DELETE; anything else is rejected with 400. Only POST is delivered.

Allowed:
string

New URL to receive the event. Not validated.

header_json
object | null

Object of header names to values. Stored and returned in clear but not sent with the request; send {} rather than null, because a null value blocks delivery of that event to every subscription on your account.

string
enum

default_payload, x-www-form-urlencoded, raw or web_push; anything else is rejected with 400. Only web_push changes delivery, routing the event to a push-notification service instead of request_url.

Allowed:
body_payload_json
object | null

Object. Stored and returned but never used in the delivered request.

boolean

false pauses the subscription so it receives nothing; true resumes it.

boolean
Responses
200

The changes were written. The body is an empty object.

401

Missing or invalid API key.

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json