Linked WhatsApp numbers, newest first: status, connection, today's caps (the warm-up applied), usage, warm-up, and WhatsApp's own limits on the number (its new-chat quota and its block on new chats).
Authorization
bearerAuth An API key created on the Access tokens page.
In: header
Query Parameters
Page size, 1–100.
1 <= value <= 10050Number of records to skip.
0 <= value0Response Body
application/json
application/json
curl -X GET "https://example.com/whatsapp-accounts"{ "data": [ { "id": "string", "label": "string", "phoneNumber": "string", "name": "string", "picture": "string", "isBusiness": true, "connectedVia": "app", "status": "pending", "connection": "connected", "error": "string", "errorCode": "string", "paused": true, "pausedReason": "string", "pausedAt": "2019-08-24T14:15:22Z", "connectedAt": "2019-08-24T14:15:22Z", "linkedAt": "2019-08-24T14:15:22Z", "limits": { "newChats": 0, "followUps": 0, "checks": 0 }, "limitsToday": { "newChats": 0, "followUps": 0, "checks": 0 }, "usage": {}, "warmup": { "enabled": true, "status": "off", "start": 0, "step": 0, "everyDays": 0, "day": 0, "newChatsToday": 0, "target": 0, "quietUntil": "2019-08-24T14:15:22Z", "fullSpeedAt": "2019-08-24T14:15:22Z" }, "newChatQuota": { "total": 0, "used": 0, "status": "NONE", "cycleEndsAt": "2019-08-24T14:15:22Z" }, "newChatsPausedUntil": "2019-08-24T14:15:22Z", "restriction": { "active": true, "endsAt": "2019-08-24T14:15:22Z", "type": "string" }, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "paging": { "limit": 0, "offset": 0 }}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.
Pause a WhatsApp number POST
Campaigns stop sending from the number until it is resumed; its leads stay assigned, and replies still arrive. Emits `account.paused` with `channel: whatsapp`.