Your API key from the console (gw_live_…).
In: header
Path Parameters
A WhatsApp account id (wa_…).
^wa_[A-Za-z0-9_-]{8,64}$Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/whatsapp/api/v1/accounts/wa_Xk2pQ9rT4vW8yZ1a"{ "object": "Account", "id": "wa_Xk2pQ9rT4vW8yZ1a", "type": "WHATSAPP", "name": "Jane Doe", "created_at": "2026-10-25T10:00:00.000Z", "connection_params": { "im": { "phone_number": "33612345678" } }, "groups": [], "sources": [ { "id": "wa_Xk2pQ9rT4vW8yZ1a_MESSAGING", "status": "OK" } ], "gateway": { "status": "active", "reason": null, "detail": null, "connection": "open", "proxy": { "network_type": "residential", "country": "FR", "ip": "203.0.113.40", "city": "Lyon", "isp": "Example Telecom", "changed_at": "2026-10-25T10:00:05.000Z", "checked_at": "2026-10-31T09:30:00.000Z" }, "checkpoint": null, "lid": "123456789012345@lid", "linked_at": "2026-10-25T10:01:00.000Z", "last_open_at": "2026-10-31T09:30:00.000Z", "new_chat_quota": null, "new_chats_block": null }}Delete a WhatsApp number DELETE
Unlinks the device on the phone (unless `provider_session_revoke=false`; a number not connected right now is not unlinked there, WhatsApp drops an idle linked device after 30 days), erases its login and its stored chats, messages and contacts, and sends `AccountStatus` `DELETED`. 503 `whatsapp-connecting` for a moment during an update of Swarmhit: retry.
Link a WhatsApp number POST
Starts a link and answers once WhatsApp shows something (a few seconds): a QR to scan, or a pairing code with `pairing_phone_number`. Both are 201 `Checkpoint`. The QR rotates about every 20 s: read the current one from `GET /accounts/{id}` (`gateway.checkpoint`). When the phone accepts, the account goes `OK` (events `CREATION_SUCCESS`, `OK`). 503 `whatsapp-connecting` when WhatsApp did not answer: try again.