OpenMax
Free Trial

Apps API · Read Receipts

Read Receipts: 3 endpoints

← All groups

POST /api/v1/conversations/{conversation_id}/read

Mark conversation read

Scope: messages:read_state:write · Called with: appToken · operationId: mark-conversation-read

Required app scope: messages:read_state:write.

Marks a conversation read through the given sequence. Response wrapped in standard envelope.

Parameters

Name In Type Required Description
conversation_id path string (uuid) yes Conversation UUID

Request body

application/json · MarkReadRequestBody

Field Type Required Description
read_until_seq integer (int64) yes Read until sequence

Responses

GET /api/v1/conversations/{conversation_id}/read-cursors

Get conversation read cursors

Scope: messages:read_state:read · Called with: appToken · operationId: get-conversation-read-cursors

Required app scope: messages:read_state:read.

Returns every member's read/ack cursor pair for read receipts: a message with seq <= last_read_seq is read by that member, seq <= last_ack_seq is delivered. Capped at 500 members ordered by last_read_seq descending; member_count carries the true total when truncated. Caller must be a non-observer member (403 for observers, 404 otherwise). Returns 412 when read receipts are disabled for the org or conversation. Response wrapped in standard envelope.

Parameters

Name In Type Required Description
conversation_id path string (uuid) yes Conversation UUID

Responses

GET /api/v1/conversations/{conversation_id}/unread

Get conversation unread count

Scope: messages:read_state:read · Called with: appToken · operationId: get-conversation-unread-count

Required app scope: messages:read_state:read.

Returns unread count for the current principal in a conversation. Response wrapped in standard envelope.

Parameters

Name In Type Required Description
conversation_id path string (uuid) yes Conversation UUID

Responses