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.

MethodPathWhat it doesPermission
POST/v1/inbox/read-allMark every message in the inbox read.
GET/v1/inbox/threadsThe inbox — one row per conversation, newest first.
GET/v1/inbox/threads/{threadKey}One conversation, oldest message first.
POST/v1/inbox/threads/{threadKey}Mark a conversation read, or archive it.
GET/v1/inbox/unreadThe number the header badge renders.