Conversations
Refer to our conversation definition for more information.
#
ListPOST /conversations.list
This is a paginated endpoint.
Filtering
This endpoint allows you to query conversations using the human readable Lucene Query Syntax. You can query on all fields defined in this class.
Sample request
Find users whose name ends with "Lovelace":
Sample request
Sample response
#
infoPOST /conversations.info
Sample request
Sample response
#
Mark conversation as readPOST /conversations.mark-read
Resets the unread count of a conversation.
Sample request
Empty response (204)
#
Tag a conversationTags an existing conversation with an existing
tag. Returns status code 200
if successful.
POST /conversations.tag
Sample request
Empty response (204)
#
Untag a conversationPOST /conversations.untag
Sample request
Empty response (204)
#
Set the state of a conversationPOST /conversations.set-state
Sample request
Empty response (204)
Supported states of a conversation are OPEN
and CLOSED
.
#
Remove the state of a conversationPOST /conversations.remove-state
Sample request
Empty response (204)
#
Update contact informationPOST /conversations.update-contact
Sample request
Empty response (204)
#
Refetch conversation metadataRefetch all conversation metadata including contact information if supported by the source
POST /conversations.refetch
Sample request
Empty response (202)