Skip to main content
Manage conversations with your customers. Conversations represent a thread of messages between agents and customers.

​
List Conversations

​
status
string
Filter by status: open, closed, pending
​
priority
string
Filter by priority: low, medium, high, urgent
​
assignedTo
string
Filter by assigned user ID
​
inboxId
string
Filter by inbox ID
​
customerId
string
Filter by customer ID
​
page
string
Page number (default: 1)
​
limit
string
Items per page (default: 50, max: 100)
​
success
boolean
true
​
data
array
Array of conversation objects
​
pagination.total
number
Total number of conversations
​
pagination.page
number
Current page number
​
pagination.limit
number
Items per page
​
pagination.totalPages
number
Total number of pages

​
Get Conversation

​
id
string
required
Conversation ID
​
success
boolean
true
​
data._id
string
Conversation ID
​
data.subject
string
Conversation subject
​
data.status
string
Status: open, closed, pending
​
data.priority
string
Priority: low, medium, high, urgent
​
data.customerId
object
Customer information (populated)
​
data.assignedTo
object
Assigned user information (populated)
​
data.channel
string
Channel: email, chat, phone, whatsapp
​
data.source
string
Source: widget, phone, api, email

​
Create Conversation

​
subject
body
required
Conversation subject
​
customerId
body
required
Customer ID
​
channel
body
Channel: email, chat, phone, whatsapp (default: email)
​
priority
body
Priority: low, medium, high, urgent (default: medium)
​
inboxId
body
Inbox ID to assign conversation to
​
success
boolean
true
​
data
object
Created conversation object

​
Update Conversation

​
id
string
required
Conversation ID
​
subject
body
Update subject
​
status
body
Update status: open, closed, pending
​
priority
body
Update priority: low, medium, high, urgent
​
assignedTo
body
Assign to user ID (set to null to unassign)

​
Delete Conversation

​
id
string
required
Conversation ID
This action cannot be undone!

​
Required Permissions

  • read:conversations - Required for GET requests
  • write:conversations - Required for POST, PUT, DELETE requests