Where a link stands: pending with the current checkpoint (the QR changes about every 20 seconds), expired (nothing was scanned in time: POST /whatsapp-accounts/{id}/relink), active with the number, or error with its code (duplicate: the number is already linked).
Authorization
bearerAuth An API key created on the Access tokens page.
In: header
Path Parameters
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/whatsapp-accounts/string/link"{ "data": { "status": "pending", "checkpoint": { "type": "qr", "qrImage": "string", "code": "string", "expiresAt": "2019-08-24T14:15:22Z" }, "accountId": "string", "phoneNumber": "string", "name": "string", "merged": true, "code": "string", "message": "string" }}WhatsApp number performance and health GET
The last 30 days of campaign messages from the number (sent, new chats, answered, delivered, read), today's usage against today's caps, and a 0-100 health score with its reasons.
Link a WhatsApp number POST
Start linking a number: show the returned QR code to the person holding the phone (WhatsApp, Settings, Linked devices, Link a device), or with `method: code` give them the pairing code to type on the phone. The QR changes about every 20 seconds: follow GET /whatsapp-accounts/{id}/link until it reads `active`, when `account.connected` also fires. A number already linked (in this workspace or another) is refused once scanned, and its new device leaves the phone. Needs the WhatsApp channel enabled for the workspace (`403` otherwise). Rate-limited: 10 links an hour per workspace, 3 pairing codes a day per phone number.