Skip to main content
POST /api/v1/forward/channel_pairings Only applicable to Channels with identity_resolution.mode=pairing.

Headers

Body parameters

Example request

Example response

HTTP 200 OK

Response fields

Error codes

Notes

  • The server uses the user_id resolved from the PAT and the normalized code to locate the pending pairing record — the request does not need channel_id.
  • Pairing codes are unique within a single user scope; the response returns the channel_id resolved by the server.
  • Submitting the same code with the same Identity and Template is idempotent and returns the existing Pairing; any different binding value returns a conflict.
  • A Channel is a transport connection; a Pairing is the actual execution context binding for that direct/room scope.
  • After successful pairing, Forward best-efforts a success notification to the original conversation; notification failure does not roll back the Pairing.

Create a channel

Unpair a channel