PATCH /webhooks/{id}
Update a subscription (merge)
| Scope | webhooks:write |
| Cost | Free |
PUT and PATCH both merge — fields you omit are left unchanged.
There is no replace-everything variant, and rather than have PUT
quietly behave like PATCH, both are documented as a merge.
A body with no updatable field is a 400, not a silent no-op.
Path parameters
| Name | Type | Required | Example | Description |
|---|---|---|---|---|
id | integer | yes | 2074 | The subscription id. |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
name | string | no | |
description | string | no | |
url | string | no | |
type | AccountRealTimeCalls | AccountEndedCalls | UserEndedCalls | AccountSMS | AccountAITranscription | no | The event a subscription fires on. Fetch the live list from GET /webhooks/types. |
enabled | boolean | no |
Point it at a new URL:
{
"url": "https://example.com/hook/v2"
}
Responses
200
The stored subscription, re-read after the write.
| Field | Type | Description |
|---|---|---|
id | integer | |
name | string | |
description | string | |
url | string | Where events are delivered. http or https, max 1024 characters. |
type | AccountRealTimeCalls | AccountEndedCalls | UserEndedCalls | AccountSMS | AccountAITranscription | The event a subscription fires on. Fetch the live list from GET /webhooks/types. |
enabled | boolean | Whether events are being delivered. |
createdAt | string (RFC 3339) | |
updatedAt | string (RFC 3339) |
Errors
| Status | Meaning |
|---|---|
400 | invalid_request — a missing or malformed field, an unknown enum value, or an unknown field in the body. Nothing was charged. |
401 | unauthenticated — no credential, or one that is invalid, revoked or expired. The WWW-Authenticate header names the scope the endpoint wanted. |
403 | Two different failures share this status, and the type tells them apart: |
404 | not_found — no such object, or it is not this account's. The two are deliberately indistinguishable. |
500 | internal_error — something failed on our side. For a send, nothing was charged, guaranteed, which is what makes a retry safe. |
See Errors for the full catalog and what to do about each.
Example
curl -X PATCH 'https://api.account.telebroad.com/api/public/v1/webhooks/2074' \
-H "Authorization: Bearer $TB_KEY" \
-H 'Content-Type: application/json' \
-d '{"url":"https://example.com/hook/v2"}'