Mark a conversation read

Workforce module

POST/conversations/{id}/mark-readconversations.markRead

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`.

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, 404, 409, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

conversations.markRead: Path and query parameters
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the conversation.

Request body: MarkConversationReadRequest

conversations.markRead: MarkConversationReadRequest
Field	Type	Required	Description
muted	boolean	No	Mute or unmute.

{
  "muted": false
}

Response 200: Conversation

conversations.markRead: Conversation
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the conversation.
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_kind	"Direct" \| "Group"	Yes	Direct or Group.
group_id	string (uuid) \| null	Yes	Identifier of the group whose conversation this is.
direct_key	string \| null	Yes	The two membership ids of a Direct conversation, sorted and joined by a colon.Constraints: length 1 to 80
last_message_at	string (date-time) \| null	Yes	When the latest message was sent.

{
  "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_kind": "Direct",
  "group_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "direct_key": "a:b",
  "last_message_at": "2026-10-08T14:30:00Z"
}

Code samples

curl -X POST "$XOS_BASE_URL/conversations/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/mark-read" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"muted":false}'

const { data } = await xos.conversations.markRead("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "muted": false
  });

response = xos.conversations.mark_read("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"muted": False})

xos conversations mark-read 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"muted":false}'