Inbox

Mark a conversation read

Moves the thread’s local read watermark to its newest synced message and returns how many incoming messages crossed from unread to read. Nothing is sent to the platform, and reading messages never does this implicitly. Requires a read-write API key.

post/v1/inbox/conversations/{conversationId}/read

Request

  • Base URL: https://api.postzen.dev
  • URL: https://api.postzen.dev/v1/inbox/conversations/{conversationId}/read
  • Auth: HTTP bearer

Request body

accountIdstring required

PostZen account id that owns the conversation.

Response

Conversation marked read.

successtrue required
markedCountinteger required

Incoming messages that crossed from unread to read on this call. Marking an already-read thread returns 0 rather than failing.

Changes

No recorded changes to this operation across all 1 revision of this API.