Mark WhatsApp message as read

Marks an inbound WhatsApp message as read and syncs the status with WhatsApp API.

Key Features:

• Only inbound messages can be marked as read
• Optimistically updates local status for immediate feedback
• Asynchronously syncs with WhatsApp API via background job
• Skips messages already marked as read
• Supports optional typing indicator control

Sandbox Mode: Messages from sandbox conversations (no WhatsApp config) are handled appropriately with sandbox-specific processing.

PATCH /whatsapp_messages/{id}/mark_as_read

Mark WhatsApp message as read

cURL

curl --request PATCH \
  --url https://app.kapso.ai/api/v1/whatsapp_messages/{id}/mark_as_read \
  --header 'X-API-Key: <api-key>'

200

{
  "data": {
    "id": "msg-123abc",
    "phone_number": "[phone]",
    "message_type": "text",
    "content": "Hello",
    "direction": "inbound",
    "status": "read",
    "whatsapp_message_id": "wamid.HBgLMTIzNDU2Nzg5MAUCAw==",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:31:00Z"
  }
}

Authorizations

X-API-Key · string · header · required

API key required for all endpoints

Path Parameters

id · string<uuid> · required

The ID of the WhatsApp message to mark as read

Query Parameters

typing_indicator · boolean · default: true

Whether to show typing indicator in WhatsApp (defaults to true)

Response

200

application/json

Message successfully marked as read

data · object

Show child attributes