Public API v2

Professional API Reference & Explorer

Built for production usage with full examples in cURL, Node.js, PHP, C#, Python, and Java. Use the right panel to switch endpoint, generate code instantly, and run live test requests exactly like modern API portals.

Authentication

All routes under /api/v2/p/* require API Key authentication.

Send your key in header: Authorization: Bearer wlk_xxx
HeaderRequiredDescription
AuthorizationYesBearer token generated from API Keys panel.

Connection Routing Headers

For sending messages, you can route per request to Meta Cloud API or QR/Baileys sessions.

HeaderValuesDescription
x-connection-type meta / qr Defaults to meta. Set qr to send through connected WhatsApp Web session.
x-instance-id string Optional. Targets a specific connected QR session when x-connection-type=qr.

Messages

POST/api/v2/p/messages/send
Send text/media/location messages to WhatsApp contacts.
POST/api/v2/p/messages/send-template
Send Meta template messages with language + parameters.

Contacts

GET/api/v2/p/contacts
List contacts with pagination and filters.
GET/api/v2/p/contacts/:id
Fetch single contact by id.
POST/api/v2/p/contacts
Create a new contact in CRM.
PUT/api/v2/p/contacts/:id
Update existing contact data.
DELETE/api/v2/p/contacts/:id
Delete contact record.

Conversations

GET/api/v2/p/conversations
List conversations with status + assignment details.
GET/api/v2/p/conversations/:chatId
Conversation details and metadata.
GET/api/v2/p/conversations/:chatId/messages
Get paginated messages within a conversation.

Templates

GET/api/v2/p/templates
List approved WhatsApp templates.
GET/api/v2/p/tags
Get contact tags metadata.

Webhooks

GET/api/v2/p/webhooks
List configured webhook endpoints.
POST/api/v2/p/webhooks
Create webhook for events.
PUT/api/v2/p/webhooks/:webhookId
Update webhook target or events.
DELETE/api/v2/p/webhooks/:webhookId
Delete webhook subscription.

Account & Extras

GET/api/v2/p/account
Current account, plan and usage details.
GET/api/v2/p/chatbots
List chatbots state and setup.
PUT/api/v2/p/chatbots/:id/toggle
Enable or disable chatbot by id.
GET/api/v2/p/agents
List available human agents.
GET/api/v2/p/analytics/summary
Get high-level analytics KPIs.