The Conversations API provides operations for creating, retrieving, searching, assigning, resolving, pinning, and managing conversation history.
The API supports both authenticated workspace operations and public visitor operations used by Web Chat.
Endpoints
| Method | Path | Purpose |
| POST | /conversations | Create a Conversation |
| GET | /conversations | List active Conversations |
| GET | /conversations/Myconversation | List assigned Conversations |
| GET | /conversations/closed | List resolved and legacy closed conversations. |
| GET | /conversations/search | Search Conversations |
| GET | /api/public/conversations/:id/status | Returns whether the public conversation resource has been deleted. |
| GET | /conversations/:id | Get Conversation |
| DELETE | /conversations/:id | Delete Conversation |
| PATCH | /conversations/:id/assign-agent | Assign Conversation |
| PATCH | /conversations/:id/unassign-agent | Unassign Conversation |
| GET | /conversations/available-agents | List assignable Agents |
| PATCH | /conversations/:id/mark-seen | Mark Conversation as seen |
| GET | /conversations/:id/assignment-history | Get assignment history |
| PATCH | /conversations/:id/close | Close Conversation |
| PATCH | /conversations/:id/pin | Pin Conversation |
| PATCH | /conversations/:id/unpin | Unpin Conversation |
| GET | /conversations/unread-count | Get unread counts |
| GET | /conversations/counts/reconcile | Reconcile unread counts |
| GET | /conversations/guest/:guestId/history | Get Guest conversation history |
| GET | /conversations/:id/download | Download transcript |
| POST | /conversations/:id/transcript | Email transcript |
| GET | /api/public/conversations/:id/agent | Get public assigned Agent summary |
| GET | /api/public/conversations/:id/meta | Get public Conversation status metadata |
Listing Conversations
GET /conversations?limit=20&cursor=<CURSOR>
Common filters include:
channelId
unassignedOnly
readStatus
sortBy
sortOrder
Assignment
Assign:
PATCH /conversations/:id/assign-agent
Body:
{
“agentId”: “<AGENT_ID>”
}
Unassign:
PATCH /conversations/:id/unassign-agent
Conversation Status
The audit currently reports these implementation values:
OPEN
RESOLVED
This is a publication blocker to verify against the current product terminology before this page is considered final.
Need Help?
Email: support@ysdesk.com
Documentation: ttps://docs.ysplugins.com/ys-desk