API reference
Inbox
5 endpoints in this area. Each one has its own page with its parameters, its response and a request you can run.
| Method | Path | What it does | Permission |
|---|---|---|---|
| POST | /v1/inbox/read-all | Mark every message in the inbox read. | Any API key |
| GET | /v1/inbox/threads | The inbox — one row per conversation, newest first. | Any API key |
| GET | /v1/inbox/threads/{threadKey} | One conversation, oldest message first. | Any API key |
| POST | /v1/inbox/threads/{threadKey} | Mark a conversation read, or archive it. | Any API key |
| GET | /v1/inbox/unread | The number the header badge renders. | Any API key |