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

# Mark a conversation as read

> Clears the organization's unread state without changing `lastActivityAt`. The operation is naturally idempotent.



## OpenAPI

````yaml /openapi/partner.yaml post /conversations/{conversationId}/read
openapi: 3.1.0
info:
  title: Passionfroot Partner API
  version: 1.0.0-alpha
  description: >
    Access a brand workspace's creators, collaborations, placements, proposals,
    and conversations.

    The API is in alpha. Every operation is restricted to the organization that
    owns the API key.
servers:
  - url: https://workspace.passionfroot.me/api/v1
security:
  - bearerAuth: []
tags:
  - name: Placements
  - name: Creators
  - name: Collaborations
  - name: Conversations
  - name: Proposals
paths:
  /conversations/{conversationId}/read:
    post:
      tags:
        - Conversations
      summary: Mark a conversation as read
      description: >-
        Clears the organization's unread state without changing
        `lastActivityAt`. The operation is naturally idempotent.
      operationId: markPartnerConversationRead
      parameters:
        - $ref: '#/components/parameters/ConversationId'
      responses:
        '200':
          $ref: '#/components/responses/PartnerConversation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  parameters:
    ConversationId:
      name: conversationId
      in: path
      required: true
      schema:
        type: string
  responses:
    PartnerConversation:
      description: The updated conversation.
      content:
        application/json:
          schema:
            type: object
            required:
              - data
            properties:
              data:
                $ref: '#/components/schemas/PartnerConversation'
    Unauthorized:
      $ref: '#/components/responses/Error401'
    Forbidden:
      $ref: '#/components/responses/Error403'
    NotFound:
      $ref: '#/components/responses/Error404'
    TooManyRequests:
      description: Rate limit exceeded.
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Too many requests, please try again later.
    Error401:
      description: Missing, invalid, expired, or revoked API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error403:
      description: The key lacks access or the required scope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error404:
      description: Resource not found or not accessible to this organization.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    PartnerConversation:
      type: object
      required:
        - id
        - creatorId
        - isUnread
        - isArchived
        - isBlocked
        - lastActivityAt
        - createdAt
      properties:
        id:
          type: string
        creatorId:
          type: string
        isUnread:
          type: boolean
        isArchived:
          type: boolean
        isBlocked:
          type: boolean
        lastActivityAt:
          type: string
          format: date-time
        createdAt:
          type: string
          format: date-time
        creator:
          $ref: '#/components/schemas/Creator'
    Error:
      type: object
      additionalProperties: false
      required:
        - error
      properties:
        error:
          type: string
    Creator:
      type: object
      required:
        - id
        - displayName
        - country
        - note
        - labels
      properties:
        id:
          type: string
        displayName:
          type: string
        country:
          type:
            - string
            - 'null'
        note:
          type:
            - string
            - 'null'
          description: Plain-text private workspace note.
        labels:
          type: array
          items:
            $ref: '#/components/schemas/Label'
        channels:
          type: array
          items:
            $ref: '#/components/schemas/Channel'
    Label:
      type: object
      required:
        - id
        - name
      properties:
        id:
          type: string
        name:
          type: string
        color:
          type: string
        position:
          type: string
    Channel:
      type: object
      required:
        - id
        - title
        - platformType
      properties:
        id:
          type: string
        title:
          type: string
        url:
          type:
            - string
            - 'null'
          format: uri
        platformType:
          type: string
        metrics:
          anyOf:
            - $ref: '#/components/schemas/Metrics'
            - type: 'null'
    Metrics:
      type: object
      properties:
        reach:
          type:
            - integer
            - 'null'
        views:
          type:
            - integer
            - 'null'
        engagement:
          type:
            - integer
            - 'null'
        engagementRate:
          type:
            - number
            - 'null'
        metricsUpdatedAt:
          type: string
          format: date-time
  headers:
    RetryAfter:
      description: Seconds to wait before retrying.
      schema:
        type: integer
        minimum: 1
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Passionfroot API key
      description: Create an API key from Settings → API in an approved Partner workspace.

````