conversations
Workforce module · 5 operations
List conversation rows
GET/conversations
A chat conversation: one-to-one between two members, or the conversation of a group. Returns a cursor page of conversation rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.
Get a conversation
GET/conversations/{id}
A chat conversation: one-to-one between two members, or the conversation of a group. Returns one conversation with its `ETag`. A conversation the caller may not see returns 404.
Start a direct conversation
POST/conversations/start-direct
Opens, or returns, the one-to-one conversation with another active member of the org. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
Mark a conversation read
POST/conversations/{id}/mark-read
Marks the conversation read up to now for the caller and optionally mutes or unmutes it. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
Read receipts
GET/conversations/{id}/read-receipts
When the other members last read the conversation; empty while the org has read receipts off. A rule that refuses the request returns 422 with `refusal` and `reason`.