Update Channel binding, display name, enable state, or response options.
POST /api/v1/forward/channels/{channel_id}
Uses merge-patch semantics. Omitted fields remain unchanged.
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT or SAT> |
Content-Type | Yes | application/json |
Idempotency-Key | No | Optional idempotency key for unsafe requests. |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
channel_id | string | Yes | Channel ID. |
Body parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | No | Channel display name. |
identity_id | string | No | New Forward Identity ID (fixed mode only). |
template_id | string | No | New Forward Template ID (fixed mode only). |
enabled | boolean | No | Manual enable or disable switch. |
channel_config.response_options | object | No | Reply visibility settings. |
Example request
Example response
HTTP 200 OK
Response fields
Returns the updated Channel object.
Error codes
| HTTP | Type | Trigger |
|---|---|---|
| 400 | invalid_request_error | Request body is invalid. |
| 401 | authentication_error | PAT or SAT is invalid or expired. |
| 404 | not_found_error | Channel does not exist. |
| 404 | not_found_error | New Template does not exist. |
| 404 | not_found_error | New Identity does not exist. |
| 409 | conflict_error | New Identity is disabled. |
Notes
id,type, andchannel_typecannot be updated.identity_resolution.modecannot be changed after creation; to switch modes you must delete and recreate the Channel.pairingmode does not allow updatingidentity_idortemplate_id; those are bound per message scope via the Pairing API.binding_statusis system-maintained.enabled=trueonly opens the manual switch. It does not changebinding_status.- In
fixedmode, updatingidentity_idortemplate_idmay stop reusing existing conversation bindings; new inbound messages use the new binding.