Skip to content
XOS Developers

chatMessages

Workforce module · 5 operations

List chat message rows

GET/chat-messages

A chat message. Photos, files and voice notes are attachments on the message. Returns a cursor page of chat message rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Create a chat message

POST/chat-messages

A chat message. Photos, files and voice notes are attachments on the message. Creates a chat message. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Get a chat message

GET/chat-messages/{id}

A chat message. Photos, files and voice notes are attachments on the message. Returns one chat message with its `ETag`. A chat message the caller may not see returns 404.

Update a chat message

PATCH/chat-messages/{id}

A chat message. Photos, files and voice notes are attachments on the message. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

Delete a chat message

DELETE/chat-messages/{id}

A chat message. Photos, files and voice notes are attachments on the message. Soft-deletes the chat message: it moves to Trash and can be restored for its table's retention period.