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

# Mark a conversation read

> Mark every message you've received in this conversation read. It clears the unread badge in the iBubbl inbox and, when read receipts are on for your account, sends the contact a read receipt: they see "Read" under their latest message on iMessage, and on RCS (Android). SMS has no read receipts.

A receipt goes out only when there was something unread, and never to a group, a blocked contact or one who opted out. `read_receipt` says whether one was queued, and why not.

Idempotent: calling again with nothing new answers `200` with `marked_count: 0`.

Counts toward the conversation-actions rate limit (300 a minute per account).

### Mark a conversation read

**Method:** `POST` | **Endpoint:** `/v1/conversations/{conversation_id}/read`

**Description:** Mark every message you've received in a conversation as read, and send the contact a read receipt: on iMessage they see **Read** under their latest message. It works on the whole conversation at once, because that's how read receipts work on iMessage and RCS. See [Tapbacks, read receipts and typing](https://docs.ibubbl.com/guides/reactions-read-receipts-typing.md#read-receipts).

**Authentication:** API key in the `Authorization` header: `Authorization: Bearer ib_pk_<64 hex>`. Create keys in the dashboard under **Settings → API access**.

**Rate limit:** 300 conversation actions per 60 seconds per account, shared with tapbacks and typing. Over that, `429 rate_limited` with a `Retry-After` header; see [Rate limits](https://docs.ibubbl.com/concepts/limits.md#rate-limits).

#### Request Body

None. The path parameter `conversation_id` is the conversation's ID (a UUID): `conversation_id` on every [message](https://docs.ibubbl.com/api-reference/messages/retrieve.md) and on every [`message.*` webhook](https://docs.ibubbl.com/webhooks/events).

#### How it behaves

* **The messages are marked read in iBubbl.** The conversation's unread badge clears in the dashboard too, for your whole team.
* **A receipt goes out only when there's something new.** `read_receipt: "queued"` means the contact will see Read within a few seconds. `"skipped"` means no receipt goes out, and `read_receipt_skipped_reason` says why.
* **Never in a group, and never to a blocked or opted-out contact.** The messages are still marked read in iBubbl.
* **Read receipts are on by default.** To turn them off for your account, email [support@ibubbl.com](mailto:support@ibubbl.com); calls then answer `skipped` with `receipts_off`.
* **It's safe to call twice.** A second call with nothing new answers `200` with `marked_count: 0`.

| `read_receipt_skipped_reason` | Meaning |
| - | - |
| `nothing_unread` | Nothing new to mark since the last read. |
| `receipts_off` | Read receipts are turned off for your account. |
| `group` | A group conversation: receipts are never sent in groups. |
| `contact_blocked` | You [blocked](https://docs.ibubbl.com/api-reference/contacts/block.md) the contact. |
| `contact_opted_out` | The contact opted out. |
| `opt_out_check_unavailable` | iBubbl couldn't check the contact's opt-out, so it sent no receipt. Call again later if it matters. |

```bash cURL theme={null}
curl -X POST https://api.ibubbl.com/v1/conversations/3a4b5c6d-7e8f-9a0b-1c2d-3e4f5a6b7c8d/read \
  -H "Authorization: Bearer $IBUBBL_API_KEY"
```

```typescript TypeScript theme={null}
const conversationId = "3a4b5c6d-7e8f-9a0b-1c2d-3e4f5a6b7c8d";

const res = await fetch(`https://api.ibubbl.com/v1/conversations/${conversationId}/read`, {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.IBUBBL_API_KEY}` },
  signal: AbortSignal.timeout(10_000),
});

const data = await res.json();
if (!res.ok) throw new Error(`${res.status} ${data.detail?.error}`);
console.log(data.marked_count, data.read_receipt, data.read_receipt_skipped_reason);
```

```python Python theme={null}
import os

import requests

API_KEY = os.environ["IBUBBL_API_KEY"]

conversation_id = "3a4b5c6d-7e8f-9a0b-1c2d-3e4f5a6b7c8d"

res = requests.post(
    f"https://api.ibubbl.com/v1/conversations/{conversation_id}/read",
    headers={"Authorization": f"Bearer {API_KEY}"},
    timeout=10,
)
data = res.json()
if not res.ok:
    raise RuntimeError(f"{res.status_code} {data['detail']['error']}")
print(data["marked_count"], data["read_receipt"], data["read_receipt_skipped_reason"])
```

```json 200 OK theme={null}
{
  "conversation_id": "3a4b5c6d-7e8f-9a0b-1c2d-3e4f5a6b7c8d",
  "marked_count": 2,
  "read_receipt": "queued",
  "read_receipt_skipped_reason": null
}
```

```json 404 Not Found theme={null}
{
  "detail": {
    "error": "not_found",
    "message": "Conversation not found"
  }
}
```

#### Responses

**200 OK**

| Field | Description |
| - | - |
| `conversation_id` | The conversation. |
| `marked_count` | How many received messages this call marked read (`0` if none were unread). |
| `read_receipt` | `queued`: the contact will see Read. `skipped`: no receipt goes out. |
| `read_receipt_skipped_reason` | Why it was skipped (table above), or `null` when queued. |

```json theme={null}
{
  "conversation_id": "3a4b5c6d-7e8f-9a0b-1c2d-3e4f5a6b7c8d",
  "marked_count": 0,
  "read_receipt": "skipped",
  "read_receipt_skipped_reason": "nothing_unread"
}
```

**401 Unauthorized**

```json theme={null}
{
  "detail": {
    "error": "unauthorized",
    "message": "Invalid or revoked API key"
  }
}
```

Other `message` values: `Authorization Bearer token required`, `API key required (use Authorization: Bearer ib_pk_…)`, `Invalid API key format`, `Customer account not found`.

**403 Forbidden**

```json theme={null}
{
  "detail": {
    "error": "forbidden",
    "message": "Account is suspended"
  }
}
```

Your iBubbl account is suspended or cancelled (`message` is then `Account is cancelled`). Every API-key endpoint returns this.

**404 Not Found**

```json theme={null}
{
  "detail": {
    "error": "not_found",
    "message": "Conversation not found"
  }
}
```

Also returned for a malformed ID and a conversation that belongs to another account.

**429 Too Many Requests**

```json theme={null}
{
  "detail": {
    "error": "rate_limited",
    "message": "Too many conversation actions; wait 12s (limit 300 a minute per account)."
  }
}
```

Wait the `Retry-After` header's seconds, then send the same request again.


## OpenAPI

````yaml POST /v1/conversations/{conversation_id}/read
openapi: 3.1.0
info:
  title: iBubbl API
  version: v1
  description: >-
    The iBubbl REST API. Send iMessages, manage contacts, and subscribe to
    webhook events from your backend.


    Authenticate every request with a Bearer API key (`ib_pk_<hex>`) — generate
    one from your dashboard's API Access settings. See the
    [Authentication](/authentication) guide.
servers:
  - url: https://api.ibubbl.com
security:
  - BearerAuth: []
tags:
  - name: Messages
  - name: Contacts
  - name: Conversations
  - name: Webhooks
  - name: Inbound Events
paths:
  /v1/conversations/{conversation_id}/read:
    post:
      tags:
        - Conversations
      summary: Mark a conversation read
      description: >-
        Mark every message you've received in this conversation read. It clears
        the unread badge in the iBubbl inbox and, when read receipts are on for
        your account, sends the contact a read receipt: they see "Read" under
        their latest message on iMessage, and on RCS (Android). SMS has no read
        receipts.


        A receipt goes out only when there was something unread, and never to a
        group, a blocked contact or one who opted out. `read_receipt` says
        whether one was queued, and why not.


        Idempotent: calling again with nothing new answers `200` with
        `marked_count: 0`.


        Counts toward the conversation-actions rate limit (300 a minute per
        account).
      operationId: v1_mark_conversation_read_v1_conversations__conversation_id__read_post
      parameters:
        - name: conversation_id
          in: path
          required: true
          schema:
            type: string
            title: Conversation Id
      responses:
        '200':
          description: Marked read.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConversationRead'
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: '`forbidden`: your iBubbl account is suspended or cancelled.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: Conversation not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          description: >-
            `rate_limited`: more than 300 conversation actions in 60 seconds
            from your account (all keys, and tapbacks, read and typing requests,
            count together; list requests have their own budget). Wait
            `Retry-After` seconds, then send the same request again.
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    ConversationRead:
      properties:
        conversation_id:
          type: string
          title: Conversation Id
          description: The conversation.
        marked_count:
          type: integer
          title: Marked Count
          description: >-
            How many received messages this call marked read (0 if they already
            were).
        read_receipt:
          type: string
          enum:
            - queued
            - skipped
          title: Read Receipt
          description: >-
            `queued`: the contact will see "Read" (iMessage, and RCS on
            Android). `skipped`: no receipt goes out; see
            `read_receipt_skipped_reason`.
        read_receipt_skipped_reason:
          anyOf:
            - type: string
              enum:
                - nothing_unread
                - receipts_off
                - group
                - contact_blocked
                - contact_opted_out
                - opt_out_check_unavailable
            - type: 'null'
          title: Read Receipt Skipped Reason
          description: >-
            Why no receipt: `nothing_unread` (nothing new since the last read),
            `receipts_off` (read receipts are off for your account), `group`
            (never sent in group conversations), `contact_blocked`,
            `contact_opted_out`, or `opt_out_check_unavailable` (the opt-out
            couldn't be checked, so none was sent). Null when queued.
      type: object
      required:
        - conversation_id
        - marked_count
        - read_receipt
        - read_receipt_skipped_reason
      title: ConversationRead
      example:
        conversation_id: 3a4b5c6d-7e8f-9a0b-1c2d-3e4f5a6b7c8d
        marked_count: 2
        read_receipt: queued
    ApiError:
      properties:
        detail:
          allOf:
            - $ref: '#/components/schemas/ApiErrorDetail'
          description: >-
            Error envelope. Every `/v1` error response wraps a stable `error`
            code and a human-readable `message` in `detail`.
      type: object
      required:
        - detail
      title: ApiError
      example:
        detail:
          error: validation_error
          message: >-
            Exactly one of contact_id, to, chat_guid, or participant_phones is
            required
    ApiErrorDetail:
      properties:
        error:
          type: string
          title: Error
          description: >-
            Stable machine-readable error code. Use this for branching logic in
            your integration; the human-readable `message` is subject to change.
            See the Error Reference for the catalog.
          examples:
            - validation_error
        message:
          type: string
          title: Message
          description: Human-readable description of what went wrong.
          examples:
            - >-
              Exactly one of contact_id, to, chat_guid, or participant_phones is
              required
      type: object
      required:
        - error
        - message
      title: ApiErrorDetail
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: ib_pk_<64 hex>
      description: >-
        Bearer API key. Format: `Authorization: Bearer ib_pk_<64 hex>` (70
        characters). Generate keys from Dashboard → Settings → API Access.

````

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