Connections

Begin pairing

Issues a short-lived, single-use grant. By default it holds a QR; with {"method": "code", "phone": "+447700900123"} it holds a pairing code instead, which the person enters under Linked devices → Link with phone number (encoding pairing-code). Either is fetched once with the grant id: each is a pairing credential, so whoever uses it links their device to the number.

post/v1/connections/{connection}/pair

Request

  • Base URL: https://www.chatrail.dev
  • URL: https://www.chatrail.dev/v1/connections/{connection}/pair
  • Auth: HTTP bearer

Path parameters

connectionstring required

Connection slug.

Request body

method'qr' | 'code'
phonestring

Response

A grant id and its expiry.

Changes

No recorded changes to this operation across all 1 revision of this API.