Reference
Operation Reference
Every operation an API key can call, with its arguments, return shape and required scope
Every operation a key can call, 169 of them, generated from the live schema so the types and arguments here cannot drift from the API.
| Group | Operations | Covers |
|---|---|---|
| Messaging | 10 | Send, edit, delete and react to messages, and upload the media they carry |
| Inbox Reads | 27 | Conversations, threads, search, media, collections and labels |
| Inbox Management | 24 | Read state, assignment, status, labels, collections, flows and deletes |
| Contacts | 17 | Read and write contacts, custom fields, and GDPR erasure |
| Channels | 30 | Connect, pause, update, the web widget, WhatsApp templates and Telegram bot settings |
| Content | 42 | Help articles, News posts and their taxonomy |
| Team | 4 | List members, add them directly, change roles and remove them |
| Tech Providers | 15 | Provision client orgs, the fan-out webhook and the usage rollup |
How to Read It
Each operation shows its kind, the scope it needs, its arguments with types, and what it returns. Two markers matter:
| Marker | Meaning |
|---|---|
| expensive | Draws on the extra rate-limit bucket as well as the normal one. |
| irreversible | Destroys data. There is no undo. |
Reference or Guide?
This section is the exhaustive, generated half. It answers "what are the exact arguments of this operation".
The GraphQL guides are the hand-written half. They answer what a generator cannot: when to use async, why a failed send may still have been delivered, why a masked key gets a 403 rather than an empty list.
Start with the guide for an area, then come here for the field-level detail.