List Conversations
string
Filter by status:
open, closed, pendingstring
Filter by priority:
low, medium, high, urgentstring
Filter by assigned user ID
string
Filter by inbox ID
string
Filter by customer ID
string
Page number (default: 1)
string
Items per page (default: 50, max: 100)
boolean
true
array
Array of conversation objects
number
Total number of conversations
number
Current page number
number
Items per page
number
Total number of pages
Get Conversation
string
required
Conversation ID
boolean
true
string
Conversation ID
string
Conversation subject
string
Status:
open, closed, pendingstring
Priority:
low, medium, high, urgentobject
Customer information (populated)
object
Assigned user information (populated)
string
Channel:
email, chat, phone, whatsappstring
Source:
widget, phone, api, emailCreate Conversation
body
required
Conversation subject
body
required
Inbox ID to assign conversation to
body
Customer ID (if creating conversation for existing customer)
body
Channel:
email, chat, phone, whatsapp (default: email)body
Priority:
low, medium, high, urgent (default: medium)boolean
true
object
Created conversation object
Update Conversation
string
required
Conversation ID
body
Update subject
body
Update status:
open, closed, pendingbody
Update priority:
low, medium, high, urgentbody
Assign to user ID (set to
null to unassign)boolean
true
object
Updated conversation object
Delete Conversation
string
required
Conversation ID
body
Reason for deletion
boolean
true
string
Success message
Required Permissions
read:conversations- Required for GET requestswrite:conversations- Required for POST, PUT, DELETE requests