Ricky logorickyDocs

Mark a conversation read

POST
/conversations/{conversation_id}/read

Marks it read for the whole team through its latest message, as opening it in the inbox does. On WhatsApp the contact sees the read receipt. Send no body.

Scope: conversations:write.

Authorization

bearerAuth
headerAuthorizationBearer <token>

An organization API key, rky_live_…, created in Settings → API. Send it only from a server.

Path Parameters

conversation_id*string

Conversation ID.

Formatuuid

Header Parameters

Idempotency-Key?string

Optional. A value you choose, unique per logical write, 8–200 characters: a UUID or an ID from your system such as order-10482-ready. Retrying with the same key and body replays the first response instead of repeating the write.

Length8 <= length <= 200

Response Body

Success.

application/json
  1. response
data*

One contact talking to the organization on one channel.

curl -X POST 'https://getricky.ai/api/v1/conversations/497f6eca-6276-4993-bfeb-53cbbbba6f08/read' \  -H 'Idempotency-Key: order-10482-ready'
{  "data": {    "id": "9b2e4c61-7a3f-4d18-b5c2-6e0f1a2b3c4d",    "channel": {      "id": "8f3c2a5e-6b1d-4c7a-9e2f-1a2b3c4d5e6f",      "type": "whatsapp"    },    "contact": {      "id": "3f6c2b1e-8d4a-4b7e-9a51-2c7d8e9f0a1b",      "display_name": "Ana Pérez",      "external_id": "50760001234",      "username": null    },    "status": "open",    "close_category": "resolved",    "assigned_user_id": "2d4f6a8c-1b3d-4e5f-8a7b-9c0d1e2f3a4b",    "agent_id": "7e8f9a0b-1c2d-4e3f-a4b5-c6d7e8f9a0b1",    "created_at": "2026-10-14T15:30:00.000Z",    "opened_at": "2026-10-14T15:30:00.000Z",    "closed_at": "2026-10-14T15:30:00.000Z",    "last_activity_at": "2026-10-14T15:30:00.000Z",    "last_activity_preview": "¿Ya están mis lentes?",    "unread": true,    "active_handoff": {      "id": "2e3f4a5b-6c7d-4e8f-9a0b-1c2d3e4f5a6b",      "status": "requested",      "requested_by": "agent",      "reason": "customer_requested",      "summary": "La clienta pide hablar con alguien sobre un reembolso.",      "assigned_user_id": "2d4f6a8c-1b3d-4e5f-8a7b-9c0d1e2f3a4b",      "requested_at": "2026-10-14T15:30:00.000Z"    }  }}