v1

latestOpenAPI 3.0.02026-08-04891301.4 MB

Mark a thread as read

Records that a user has read up to a specific message in the thread. Unread indicators and badge counts are cleared up to the specified message.

You must supply exactly one of last_read_message or use_latest_message. Omitting both returns 400. If use_latest_message is true and the thread has no messages, the request succeeds silently with no state change.

For server-to-server (S2S) requests where no user identity is present in the token, the user param is required to identify whose read state to update.

post/api/v1/threads/{thread}/mark_read

Path parameters

threadstring required

Thread ID (thr_...). The thread to mark as read.

Request body

last_read_messagestring

Message ID (msg_...) to record as the last read message. Mutually exclusive with use_latest_message.

use_latest_messageboolean

When true, marks the thread as read up to the latest message. Mutually exclusive with last_read_message.

userstring

User ID (usr_...) whose read state to update. Required for S2S requests; ignored when an authenticated user is present in the token.

Example request

{
  "last_read_message": "string",
  "use_latest_message": true,
  "user": "string"
}

Response

No content