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

# Mark a conversation read

> Resets `unreadCount` in your inbox. Sends no read receipt to the contact.



## OpenAPI

````yaml /api-reference/v2/openapi.json post /v2/conversations/{conversationId}/read
openapi: 3.0.3
info:
  title: Zavu API v2
  version: 2.0.0
  description: >-
    The second version of the Zavu API. It runs on the same engine as /v1: the
    same API keys, the same per-project rate limit, the same sending limits,
    prices and reviews. /v1 keeps working unchanged, and you can mix calls to
    both.


    **Addresses, not senders.** /v2 has no sender object. Where a message leaves
    from is named the way the recipient sees it: an E.164 number, an email
    address, `@botname` for Telegram, `@username` for Instagram, the Facebook
    Page id for Messenger, and the literal `sms_oneway` for one-way SMS (sent
    from shared numbers, never a number of your own). `GET /v2/channels` lists
    one entry per (address, type); a number that carries WhatsApp and SMS is two
    entries with the same address.


    **What else changes.** No `Zavu-Sender` header (`from` or `conversationId`
    instead); every send reports how it was routed; one project webhook carries
    every event; every error is `{code, message, details}` at the root.


    **Wrong method.** A path under `/v2/messages`, `/v2/conversations`,
    `/v2/contacts`, `/v2/channels`, `/v2/templates`, `/v2/campaigns`,
    `/v2/agents`, `/v2/webhook` or `/v2/email-domains` called with a method it
    does not take answers `405 method_not_allowed`, with `details.allowed` and
    an `Allow` header.


    **Money.** Every amount is USD, rounded to 6 decimals.
servers:
  - url: https://api.zavu.dev
security:
  - bearerAuth: []
tags:
  - name: Messages
    description: Send, list and read messages.
  - name: Conversations
    description: Inbox threads, one per contact across channels.
  - name: Contacts
    description: Contacts and the identifiers they are reached at.
  - name: Channels
    description: 'Where the project can send from: one entry per (address, type).'
  - name: Templates
    description: WhatsApp message templates.
  - name: Campaigns
    description: One message to many recipients.
  - name: Webhook
    description: The one project webhook for every event.
  - name: Agents
    description: AI agents and the addresses they answer on.
  - name: Numbers
    description: Search and buy phone numbers.
  - name: Email Domains
    description: Domains to send email from.
  - name: Functions
    description: Configure Zavu Functions.
paths:
  /v2/conversations/{conversationId}/read:
    post:
      tags:
        - Conversations
      summary: Mark a conversation read
      description: >-
        Resets `unreadCount` in your inbox. Sends no read receipt to the
        contact.
      operationId: markConversationReadV2
      parameters:
        - name: conversationId
          in: path
          required: true
          description: ''
          schema:
            type: string
      responses:
        '200':
          description: Updated conversation.
          content:
            application/json:
              schema:
                type: object
                required:
                  - conversation
                properties:
                  conversation:
                    $ref: '#/components/schemas/Conversation'
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Conversation not found, or it belongs to another project.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    Conversation:
      type: object
      description: >-
        An inbox thread with one contact. A conversation groups every message
        exchanged with that contact across channels, so a contact who writes on
        WhatsApp and later by email stays in one thread.
      required:
        - id
        - contactIdentifier
        - channels
        - lastMessage
        - messageCount
        - unreadCount
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
          example: js723987cyghwqxxaxcf590qd18axd95
        contactId:
          type: string
          description: >-
            ID of the contact this thread belongs to. Absent on group threads
            and on threads whose contact has not been resolved yet.
        contactIdentifier:
          type: string
          description: >-
            The key this thread is filed under: a phone number in E.164, a
            WhatsApp business-scoped user ID (BSUID), or a numeric chat ID
            (Telegram/Instagram/Messenger). It is not always a phone number, so
            do not parse it as one.
          example: '+56912345678'
        email:
          type: string
          description: Email address of the thread, when the contact was reached by email.
        channels:
          type: array
          items:
            type: string
          description: Every channel this thread has carried messages on.
          example:
            - whatsapp
            - sms
        lastMessage:
          type: object
          description: >-
            Denormalized preview of the most recent message, so a thread list
            needs no extra fetch.
          required:
            - id
            - text
            - channel
            - direction
            - at
          properties:
            id:
              type: string
            text:
              type: string
              description: >-
                Text or caption. Empty when the last message carried no text
                (e.g. media).
            channel:
              $ref: '#/components/schemas/ChannelType'
            direction:
              type: string
              enum:
                - inbound
                - outbound
            at:
              type: string
              format: date-time
        messageCount:
          type: integer
        unreadCount:
          type: integer
          description: >-
            Inbound messages not yet marked read. Reset with POST
            /v2/conversations/{conversationId}/read.
        whatsapp:
          type: object
          description: WhatsApp identity, present when the contact adopted a username.
          properties:
            bsuid:
              type: string
              description: Business-scoped user ID. Can be used as `to` when sending.
            username:
              type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        from:
          type: string
          nullable: true
          description: >-
            The address this thread was last handled from, on the transport of
            its last message. Pass the conversation's `id` as `conversationId`
            on `POST /v2/messages` to reply from it. A thread opened by an API
            send before /v2 recorded no sender; its `from` is read off its
            messages. `?from=` on the list matches threads by the recorded
            sender only, which messages sent through /v2 record.
    Error:
      type: object
      required:
        - code
        - message
      description: >-
        Every v2 error has this shape at the root. There is no `{error: {...}}`
        wrapper anywhere in v2. A missing resource is `404 not_found` with the
        message `<Resource> not found`; an address the project does not have is
        `404 not_found`, `None of this project's channels has the address
        <address>.`, with the address in `details` under the name the request
        used (`from` or `address`). A `message` is written for the caller and
        never carries a stack trace or a source path. A body that is not JSON is
        `400 invalid_json`, with `details.errors` (`path: []`, the parse error
        in `message`).
      properties:
        code:
          type: string
          example: invalid_request
        message:
          type: string
        details:
          type: object
          additionalProperties: true
          description: >-
            Machine-readable context. Keys that mean the same thing everywhere:

            - `errors`: present on every `400 invalid_request` for an invalid
            body or query parameter, `[{path, message, ...}]`, `path` naming the
            field (`["to"]`, `["contacts", 2, "recipient"]`, `["limit"]`).

            - `recommendation`: one sentence saying what to do next.

            - `dashboardUrl`: the dashboard screen that fixes it.

            - `connect`: on `409 no_channel`, the channels this project can
            connect to reach the recipient, each `{type, request, note,
            available, dashboardUrl?}`; `request` is the exact call (`POST
            /v2/channels` with its body, or `POST /v2/numbers`), or null for a
            channel connected from the dashboard (WhatsApp, Instagram,
            Messenger). `available: false` says why in `note` (one-way SMS
            closed until business verification is approved).

            - `address` / `from`: the address the error is about, under the name
            the request used for it.
          properties:
            errors:
              type: array
              items:
                type: object
                required:
                  - path
                  - message
                properties:
                  path:
                    type: array
                    items:
                      oneOf:
                        - type: string
                        - type: integer
                  message:
                    type: string
                  code:
                    type: string
                additionalProperties: true
    ChannelType:
      type: string
      description: A transport a message travels on.
      enum:
        - sms
        - sms_oneway
        - whatsapp
        - telegram
        - email
        - instagram
        - messenger
        - voice
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.