Every endpoint, in one page
Eight resource groups covering messages, conversations, contacts, leads, campaigns, tickets, the knowledge base and analytics. Authentication and webhooks are covered in the docs.
X-Api-Key: $WABOXA_API_KEY
Base URL: https://api.waboxa.com/v1Messages
Send on your WhatsApp number and read what has already been sent or received.
| Endpoint | Description | Parameters |
|---|---|---|
POST/v1/messages | Send a text, media, template or interactive message. | to, type, text | media | template, idempotencyKey |
GET/v1/messages | List messages, newest first. | conversationId, before, after, limit |
GET/v1/messages/{id} | Fetch one message with its delivery status. | — |
Conversations
Threads, their assignment and their state.
| Endpoint | Description | Parameters |
|---|---|---|
GET/v1/conversations | List conversations with the latest message on each. | status, assigneeId, tag, search, limit, cursor |
GET/v1/conversations/{id} | Fetch one thread with its contact and message history. | — |
PATCH/v1/conversations/{id} | Assign, close, reopen or tag a thread. | assigneeId, status, tags |
Contacts
The people on the other end of every conversation.
| Endpoint | Description | Parameters |
|---|---|---|
GET/v1/contacts | List or search contacts. | search, tag, source, limit, cursor |
POST/v1/contacts | Create a contact, or update one by matching phone number. | name, phone, email, tags, customFields |
GET/v1/contacts/{id} | Fetch one contact with its lead and conversation links. | — |
PATCH/v1/contacts/{id} | Update fields or tags on a contact. | name, email, tags, customFields |
DELETE/v1/contacts/{id} | Delete a contact and its personal data. | — |
Leads & pipeline
Qualification scores, stages and pipeline movement.
| Endpoint | Description | Parameters |
|---|---|---|
GET/v1/leads | List leads filtered by stage, score band or owner. | stage, minScore, maxScore, ownerId, limit, cursor |
POST/v1/leads | Create a lead against an existing contact. | contactId, stage, value, source, notes |
GET/v1/leads/{id} | Fetch a lead with its BANT breakdown and score history. | — |
PATCH/v1/leads/{id} | Move a lead between stages or change its owner. | stage, ownerId, value, notes |
GET/v1/lead-stages | List the pipeline stages configured for the workspace. | — |
Campaigns & templates
Broadcasts to a segment, and the Meta-approved templates they use.
| Endpoint | Description | Parameters |
|---|---|---|
GET/v1/campaigns | List campaigns with per-recipient counters. | status, limit, cursor |
POST/v1/campaigns | Create and optionally schedule a campaign. | name, templateId, segment, scheduledAt, variables |
GET/v1/campaigns/{id} | Fetch a campaign with delivery, read and reply breakdown. | — |
GET/v1/templates | List templates and their Meta approval status. | status, category, language |
POST/v1/templates | Submit a template to Meta for review. | name, category, language, components |
Tickets
Support threads with a priority and an SLA clock.
| Endpoint | Description | Parameters |
|---|---|---|
GET/v1/tickets | List tickets by status, priority or assignee. | status, priority, assigneeId, limit, cursor |
POST/v1/tickets | Open a ticket from a conversation. | conversationId, subject, priority, assigneeId |
PATCH/v1/tickets/{id} | Reassign, reprioritise or resolve a ticket. | status, priority, assigneeId, resolution |
Knowledge base
The documents the AI answers from, and the FAQs layered on them.
| Endpoint | Description | Parameters |
|---|---|---|
GET/v1/knowledge | List indexed documents and their processing state. | status, limit, cursor |
POST/v1/knowledge | Upload a PDF or DOCX, or submit raw text, for indexing. | title, file | text, tags |
DELETE/v1/knowledge/{id} | Remove a document and its embeddings. | — |
Analytics
The same figures the dashboard renders, as JSON.
| Endpoint | Description | Parameters |
|---|---|---|
GET/v1/analytics | Response times, lead counts, conversion and campaign performance. | from, to, granularity, metrics |
GET/v1/export | Export contacts, leads or interactions as CSV. | resource, from, to, format |
Errors
Eight codes worth branching on
Every error response carries a stable `code`, an HTTP `status` and a human `message`. Branch on the code — the message is written for people and may change.
| Code | Status | When it happens |
|---|---|---|
unauthorized | 401 | Missing, malformed or revoked API key. |
forbidden | 403 | The key is valid but not scoped for this action. |
not_found | 404 | No resource with that id in this workspace. |
validation_failed | 422 | A parameter is missing or the wrong shape. `details` names the field. |
template_not_approved | 422 | Meta has not approved the template you tried to send. |
outside_session_window | 422 | The 24-hour window has closed; send an approved template instead. |
rate_limited | 429 | Workspace rate limit reached. Wait for `Retry-After` seconds. |
upstream_error | 502 | Meta's Cloud API returned an error. `upstream` carries their payload. |
Errors raised by Meta's Cloud API are passed through under upstream rather than rewritten, so you can act on their codes directly.
Ready to build?
Request a workspace key and we will help you get the first call returning 200.