Create a chat message

Workforce module

POST/chat-messageschatMessages.create

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.

Requires the capability inbox.notifications.write.
OAuth scopes: inbox.
Send an Idempotency-Key header. A replay with the same key returns the original response.
Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: ChatMessageCreate

chatMessages.create: ChatMessageCreate
Field	Type	Required	Description
conversation_id	string (uuid)	Yes	Identifier of the conversation.
message_kind	"Text" \| "Photo" \| "File" \| "Voice"	Yes	What the message carries.
body	string \| null	No	Message text; optional for a photo, file or voice note.Constraints: length 1 to 4000
language	string \| null	No	Language the author wrote in.Constraints: pattern ^[a-z]{2,3}(-[A-Z]{2})?$

{
  "conversation_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "message_kind": "Text",
  "body": "Points are up on stage left.",
  "language": "en-US"
}

Response 201: ChatMessage

chatMessages.create: ChatMessage
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the chat message.
org_id	string (uuid)	Yes	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Yes	When the row was created.
created_by	string (uuid) \| null	Yes	Person who created the row; null for seed, platform or system writes.
updated_at	string (date-time)	Yes	When the row was last updated.
updated_by	string (uuid) \| null	Yes	Person who last updated the row; null for seed, platform or system writes.
conversation_id	string (uuid)	Yes	Identifier of the conversation.
author_membership_id	string (uuid)	Yes	Identifier of the member who sent it.
message_kind	"Text" \| "Photo" \| "File" \| "Voice"	Yes	What the message carries.
body	string \| null	Yes	Message text; optional for a photo, file or voice note.Constraints: length 1 to 4000
language	string \| null	Yes	Language the author wrote in.Constraints: pattern ^[a-z]{2,3}(-[A-Z]{2})?$
edited_at	string (date-time) \| null	Yes	When the author last edited the text.

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "conversation_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "author_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "message_kind": "Text",
  "body": "Points are up on stage left.",
  "language": "en-US",
  "edited_at": "2026-10-08T14:30:00Z"
}

Code samples

curl -X POST "$XOS_BASE_URL/chat-messages" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"conversation_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","message_kind":"Text","body":"Points are up on stage left.","language":"en-US"}'

const { data } = await xos.chatMessages.create({
    "conversation_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "message_kind": "Text",
    "body": "Points are up on stage left.",
    "language": "en-US"
  });

response = xos.chat_messages.create({"conversation_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "message_kind": "Text", "body": "Points are up on stage left.", "language": "en-US"})

xos chat-messages create --data '{"conversation_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","message_kind":"Text","body":"Points are up on stage left.","language":"en-US"}'