Change the Identity or Template of an active Channel pairing.
Channel pairing is currently in Beta. API definitions, response structures, and behavior may change. Check the documentation for updates.
POST /api/v1/forward/channel_pairings/{pairing_id}
Change the Identity or Template of a bound (active) record. For a pending (pairing) record, use Pair a channel.
Request parameters
Use Authorization: Bearer <PAT or SAT> and Content-Type: application/json. The path parameter pairing_id is the pairing record's id.
| Body parameter | Type | Description |
|---|---|---|
identity_id | string | New Identity ID. |
template_id | string | New Template ID. |
null are not supported. The Channel and pairing scope cannot be changed. scope_display_name comes from channel messages and cannot be changed manually.
Example request
Response
Success returns HTTP 200 OK with the updated pairing object, using the same structure as Get a channel pairing. The status remains active.
After the binding changes, new messages use the new execution configuration, and existing sessions are no longer reused. Submitting the same values again does not change the binding again.
Common errors
| HTTP | Description |
|---|---|
| 400 | No updatable fields were provided, or a parameter value is invalid. |
| 401 | Credentials are invalid or expired. |
| 404 | The bound record, Identity, or Template does not exist or is inaccessible to the caller. |
| 409 | Pairing status conflict, or the new Identity is disabled. |

