REST API

Authentication

Create a key from Dashboard → API keys. The secret is shown once, at creation. Send both headers with every request.

X-Api-Key: wapi_xxxxxxxxxxxx
X-Api-Secret: wask_xxxxxxxxxxxx

Keys can be limited to specific IP addresses and have their own per-minute rate limit.

Plain text message

{
  "to": "919876543210",
  "message": "Hello! Your order has been confirmed."
}

Image, video or document

{
  "to": "919876543210",
  "type": "image",
  "url": "https://example.com/bill.jpg",
  "caption": "Your invoice"
}

Approved template (outside the 24-hour window)

{
  "to": "919876543210",
  "template": "order_update",
  "language": "en_US",
  "params": ["Rahul", "ORD-1029"]
}

Create or update a contact

{
  "name": "Rahul Sharma",
  "phone": "919876543210",
  "email": "rahul@example.com"
}

List contacts (query: q, per_page)

Plan details and remaining quota

Credit balance and plan quota left

List contact groups

List templates with approval status

Create and launch a bulk campaign

{
  "name": "Diwali offer",
  "template_id": 4,
  "category": "marketing",
  "group_ids": [2, 5],
  "speed_per_minute": 30,
  "start": true
}

Live progress of one campaign

List contacts, paginated

Create or update a contact

{
  "phone": "919876543210",
  "name": "Asha Verma",
  "email": "asha@example.com",
  "tags": ["vip"]
}

Response format

{
  "success": true,
  "message": "Message queued to WhatsApp.",
  "data": { "wamid": "wamid.HBgM..." }
}

Error codes: 401 invalid credentials · 402 quota exhausted · 403 IP not allowed · 422 validation or WhatsApp error · 429 rate limit (120 req/min).