API reference
The reference is generated from the register of the API. It is always the same as the real API: a call that is not here does not exist.
Each call page shows: what it does, the permission it needs, the risk, whether an Idempotency-Key is needed, all parameters, working examples in three languages, the answer and every error it can return.
#Areas
| Area | What it is for | Operations |
|---|---|---|
| Account | The account overview. | 2 |
| AI reply | Settings and learned answers of the SmartChat AI reply. | 5 |
| Automations | Automations, their catalog and their runs. | 9 |
| Billing | Plan, invoices and credit history (read only). | 3 |
| Business profile | The business profile. | 2 |
| Connection and apps | Connection check and connected apps. | 2 |
| Contacts | People you can message: contacts, tags, opt-in state. | 10 |
| Conversations | Conversations and messages in the inbox. | 5 |
| Follow-ups | Follow-up sequences and their steps. | 6 |
| Knowledge | Knowledge documents and search. | 2 |
| Landing page | The landing page: read, edit a draft, publish. | 5 |
| Media | The media library. | 2 |
| Newsletters | Newsletters: drafts, previews, sending and tests. | 8 |
| Sends | Single messages (free text inside the 24-hour window, or approved templates) and their status. | 3 |
| Statistics | Statistics without personal data. | 1 |
| Team | Team members (read only). | 1 |
| Templates | WhatsApp message templates. | 5 |
| Webhook endpoints | Outgoing webhook endpoints, deliveries and tests. | 11 |
#Before you read
- Conventions: names, IDs, times, answers.
- Errors and the error catalog.
- Pagination, filters and sorting.
- All permissions.
- OpenAPI, Postman and other files.