API reference

Numbers

Add numbers, pair them with a QR or a pairing code, follow their connection and manage their webhooks. Tip: a WhatsApp Business number with a real profile (name, photo, description) is trusted more by customers and by WhatsApp.

Endpoints

• GET/v2/numbersList numbersScope: numbers:read
• POST/v2/numbersAdd a number and start pairingScope: numbers:write
• GET/v2/numbers/{numberId}Get a numberScope: numbers:read
• PATCH/v2/numbers/{numberId}Rename a numberScope: numbers:write
• GET/v2/numbers/{numberId}/statusConnection statusScope: numbers:read
• GET/v2/numbers/{numberId}/qrCurrent QRScope: numbers:write
• POST/v2/numbers/{numberId}/pairing-codePairing code (no QR)Scope: numbers:write
• POST/v2/numbers/{numberId}/reconnectReconnectScope: numbers:write
• POST/v2/numbers/{numberId}/logoutLog out (unlink)Scope: numbers:write
• DELETE/v2/numbers/{numberId}Delete a numberScope: numbers:write
• POST/v2/numbers/{numberId}/contacts/checkCheck numbers on WhatsApp (1–50)Scope: numbers:read
• GET/v2/numbers/{numberId}/webhookWebhook of a numberScope: webhooks:read
• PUT/v2/numbers/{numberId}/webhookSet the webhook of a numberScope: webhooks:write
• DELETE/v2/numbers/{numberId}/webhookRemove the webhook of a numberScope: webhooks:write
• POST/v2/numbers/{numberId}/webhook/testSend a test eventScope: webhooks:write
• POST/v2/numbers/{numberId}/webhook/rotate-secretRotate the signing secretScope: webhooks:write