API reference

Inbox API

Human handoff. The queue of visitors waiting for a person, longest wait first, and the calls a teammate makes to claim a conversation, reply in it, release it or resolve it.

Endpoints

5 operations, each with its parameters, schemas and an example request on its own page.

get/api/inboxList the inbox — Everyone waiting for a person, longest wait first.
post/api/inbox/{conversation_id}/claimClaim a conversation — Takes ownership of a waiting conversation.
post/api/inbox/{conversation_id}/releaseRelease a conversation — Puts it back in the unassigned queue for somebody else.
post/api/inbox/{conversation_id}/replyReply to a conversation — Sends a message the visitor will see.
post/api/inbox/{conversation_id}/resolveResolve a conversation — Ends the human's involvement.

Authentication

Every call here needs Authorization: Bearer with a key from the dashboard — Authentication covers keys and scopes.

Objects returned

The models these endpoints send back, with every field. Open one to read it.

PaginatedResponse_InboxItem_6 fields

itemsarray of InboxItemrequired
17 fields · InboxItem
- bot_idstringrequired
- idstringrequired
- visitor_idstringrequired
- assigned_atany
- assigned_to_idstring | null
- assigned_to_namestring | null
- contact_emailstring | null
- contact_namestring | null
- handoff_reasonstring | null
- handoff_requested_atany
- last_message_atany
- message_countinteger
  Default: 0
- page_urlstring | null
- titlestring | null
- visitor_presentboolean
  Default: false
- visitor_seen_atany
- waiting_secondsinteger
  Default: 0
pageintegerrequired
page_sizeintegerrequired
totalintegerrequired
has_moreboolean
Default: false
next_cursorstring | null

Message2 fields

messagestringrequired
okboolean
Default: true

Something here wrong or missing? Tell us — the documentation and the API are maintained by the same person, so a correction is a fix rather than a ticket.