WhatsApp Gateway
API referenceSessions

Request a phone pairing code

POST
/api/v1/sessions/{session}/pairing-code

Get a phone pairing code so the session can be linked without QR scanning.

Pass phone in E.164 digits (no plus sign). The returned code is short-lived and must be used from the phone.

Requires manage capability; session must be unpaired.

Errors: validation_error (400), not_found (404), unauthorized (401), forbidden (403).

Authorization

AuthorizationBearer <token>

Send Authorization: Bearer <token>. The token can be a login JWT from the frontend or an api-key for a script. JWT access comes from the person's organization role. Api-key access comes from the permissions saved on the key.

In: header

Path Parameters

session*string

Session ID to generate a pairing code for. Must belong to your organization and be unpaired.

Example"sess_01HZX8K3M9"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

phone?string

Phone number to pair in E.164 digits only (country code + number, no + or spaces).

Example"628123456789"

Response Body

application/json

application/json

curl -X POST "https://example.com/api/v1/sessions/sess_01HZX8K3M9/pairing-code" \  -H "Content-Type: application/json" \  -d '{}'
{  "code": "string"}
{  "error": {    "code": "not_found",    "details": {      "property1": null,      "property2": null    },    "message": "session not found"  }}