Skip to main content
A connection is one WhatsApp account. Pairing, messages, media, and groups all happen through the selected connection.

​
One connection per request

Every REST request to /v1/whatsapp/* resolves to exactly one connection:
  • If your API key allows one connection, the backend uses it automatically.
  • If your API key allows multiple connections, include X-WhatsApp-Use-Connection-Id.
cURL
curl \
  -H "Authorization: Bearer $WHATSAPP_USE_API_KEY" \
  -H "X-WhatsApp-Use-Connection-Id: conn_abc123" \
  "$WHATSAPP_USE_BASE_URL/v1/whatsapp/status"

​
Multiple WhatsApp accounts

Create multiple connections when your organization manages multiple WhatsApp accounts. Keep API keys broad enough for your service boundary, and pass the connection ID at request time when a key can reach more than one account.

​
Connection lifecycle

Pair a connection before using it for messages, media, or groups. If the connection is not paired or connected, WhatsApp endpoints return an error that your application can surface to the user.