> ## Documentation Index
> Fetch the complete documentation index at: https://docs.postbreeze.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Mark a comment read or unread

> Flips a comment between read and unread.

Sending nothing in the body — or `{ "read": true }` — marks the comment as read. Send `{ "read": false }` to mark it back as unread.

This only affects your Postbreeze inbox. Nothing gets sent to the social platform — read state is just for you and your team.



## OpenAPI

````yaml /openapi.json post /comments/{commentId}/read
openapi: 3.0.0
info:
  title: Postbreeze API
  description: >-
    Public REST API for scheduling and managing social posts. Authenticate every
    request with `Authorization: Bearer pb_live_…`. All endpoints are scoped to
    a single workspace; an API key issued for workspace A cannot access
    workspace B.
  version: 1.0.0
  contact: {}
servers:
  - url: http://localhost:4100/api/v1
security:
  - bearer: []
tags: []
paths:
  /comments/{commentId}/read:
    post:
      tags:
        - Comments
      summary: Mark a comment read or unread
      description: >-
        Flips a comment between read and unread.


        Sending nothing in the body — or `{ "read": true }` — marks the comment
        as read. Send `{ "read": false }` to mark it back as unread.


        This only affects your Postbreeze inbox. Nothing gets sent to the social
        platform — read state is just for you and your team.
      operationId: CommentsV1Controller_markRead
      parameters:
        - name: commentId
          required: true
          in: path
          description: Prefixed cuid of the inbox comment to update.
          schema:
            example: cmt_01HZY8N3M2K9R5T8V4P6Q1J0BC
            type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MarkCommentReadDto'
      responses:
        '201':
          description: Read state updated.
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    description: Always `true` on success.
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: integer
                    example: 400
                  code:
                    type: string
                    example: VALIDATION_FAILED
                  message:
                    type: string
                  requestId:
                    type: string
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: integer
                    example: 401
                  message:
                    type: string
                    example: Unauthorized
                  requestId:
                    type: string
components:
  schemas:
    MarkCommentReadDto:
      type: object
      properties:
        read:
          type: boolean
          description: >-
            Pass `false` to mark the comment unread (clears `readAt`). Defaults
            to `true` — i.e. an empty body marks the comment read.
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: API key
      type: http
      description: Your Postbreeze API key

````