Inbox
Conversations
Read and reply to inbox conversations, assign them, and change their status and priority.
12 endpoints
- GETList conversations/api/ext/omni_v2/conversation/conversationReturns a paginated list of conversations (omnichannel inbox threads) for the project that owns the API key.
- POSTFilter conversations/api/ext/omni_v2/conversation/conversation/filterLists conversations matching a structured filter expression supplied in the JSON body, returning the same response shape as the generic list endpoint (meta folder counts plus a payload array of conversation summaries).
- POSTList conversations by contact/api/ext/omni_v2/conversation/conversation/contact/{contact_id}Lists conversations belonging to the contact identified by contact_id, with optional server-side filtering supplied in the request body and pagination via the page query parameter.
- GETGet conversation/api/ext/omni_v2/conversation/conversation/{id}Returns the full detail of a single conversation thread, including its metadata, the contact/sender and assignee in meta, the last_non_activity_message, and an embedded messages array.
- GETList conversation messages/api/ext/omni_v2/conversation/conversation/{id}/messagesReturns a page of messages for the conversation, newest-relevant first, using cursor-based pagination via the before query parameter.
- POSTSend a message/api/ext/omni_v2/conversation/conversation/{id}/messagesSends a new message into the conversation.
- POSTSend a message with an attachment/api/ext/omni_v2/conversation/conversation/{id}/messages_with_attachmentSends a message into the conversation with a file attachment.
- GETList conversation attachments/api/ext/omni_v2/conversation/conversation/{id}/attachmentsReturns every attachment shared in the conversation across all of its messages, in a single flat list.
- POSTAssign conversation/api/ext/omni_v2/conversation/conversation/{id}/assignAssigns the conversation to a workspace member (agent).
- POSTChange conversation status/api/ext/omni_v2/conversation/conversation/{id}/toggle_statusChanges the lifecycle status of the conversation.
- POSTChange conversation priority/api/ext/omni_v2/conversation/conversation/{id}/toggle_prioritySets the priority of the conversation.
- POSTMark conversation as seen/api/ext/omni_v2/conversation/conversation/{id}/update_last_seenMarks the conversation as seen by the agent/assignee, updating the server-side last-seen timestamp and clearing the unread state for the agent side.