Skip to main content
POST
/
comments
/
{commentId}
/
read
Mark a comment read or unread
curl --request POST \
  --url http://localhost:4100/api/v1/comments/{commentId}/read \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "read": true
}'
{
  "ok": true
}

Authorizations

​
Authorization
string
header
required

Your Postbreeze API key

Path Parameters

​
commentId
string
required

Prefixed cuid of the inbox comment to update.

Example:

"cmt_01HZY8N3M2K9R5T8V4P6Q1J0BC"

Body

application/json
​
read
boolean

Pass false to mark the comment unread (clears readAt). Defaults to true — i.e. an empty body marks the comment read.

Response

Read state updated.

​
ok
boolean

Always true on success.