# API reference

> Every call of the REST API, grouped by area, with permission, parameters, examples in curl, Python and TypeScript, and all possible errors.

Last updated: 2026-10-30. Source: https://docs.smartchat.marketing/en/api/

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](https://docs.smartchat.marketing/en/api/reference/account/) | The account overview. | 2 |
| [AI reply](https://docs.smartchat.marketing/en/api/reference/ai_reply/) | Settings and learned answers of the SmartChat AI reply. | 5 |
| [Automations](https://docs.smartchat.marketing/en/api/reference/automations/) | Automations, their catalog and their runs. | 9 |
| [Billing](https://docs.smartchat.marketing/en/api/reference/billing/) | Plan, invoices and credit history (read only). | 3 |
| [Business profile](https://docs.smartchat.marketing/en/api/reference/business_profile/) | The business profile. | 2 |
| [Connection and apps](https://docs.smartchat.marketing/en/api/reference/meta/) | Connection check and connected apps. | 2 |
| [Contacts](https://docs.smartchat.marketing/en/api/reference/contacts/) | People you can message: contacts, tags, opt-in state. | 10 |
| [Conversations](https://docs.smartchat.marketing/en/api/reference/conversations/) | Conversations and messages in the inbox. | 5 |
| [Follow-ups](https://docs.smartchat.marketing/en/api/reference/followups/) | Follow-up sequences and their steps. | 6 |
| [Knowledge](https://docs.smartchat.marketing/en/api/reference/knowledge/) | Knowledge documents and search. | 2 |
| [Landing page](https://docs.smartchat.marketing/en/api/reference/landing/) | The landing page: read, edit a draft, publish. | 5 |
| [Media](https://docs.smartchat.marketing/en/api/reference/media/) | The media library. | 2 |
| [Newsletters](https://docs.smartchat.marketing/en/api/reference/newsletters/) | Newsletters: drafts, previews, sending and tests. | 8 |
| [Sends](https://docs.smartchat.marketing/en/api/reference/sends/) | Single messages (free text inside the 24-hour window, or approved templates) and their status. | 3 |
| [Statistics](https://docs.smartchat.marketing/en/api/reference/stats/) | Statistics without personal data. | 1 |
| [Team](https://docs.smartchat.marketing/en/api/reference/team/) | Team members (read only). | 1 |
| [Templates](https://docs.smartchat.marketing/en/api/reference/templates/) | WhatsApp message templates. | 5 |
| [Webhook endpoints](https://docs.smartchat.marketing/en/api/reference/webhooks/) | Outgoing webhook endpoints, deliveries and tests. | 11 |

## Before you read

- [Conventions](https://docs.smartchat.marketing/en/concepts/conventions/): names, IDs, times, answers.
- [Errors](https://docs.smartchat.marketing/en/concepts/errors-overview/) and the [error catalog](https://docs.smartchat.marketing/en/errors/).
- [Pagination, filters and sorting](https://docs.smartchat.marketing/en/concepts/pagination/).
- [All permissions](https://docs.smartchat.marketing/en/api/permissions/).
- [OpenAPI, Postman and other files](https://docs.smartchat.marketing/en/api/openapi/).