Skip to main content
Auth. HMAC v1 or bearer token - see Authentication. Status. Live · Idempotent: Yes (re-marking an already-read chat is a no-op).
Mark unread inbound messages in a chat as read and send a read receipt from the chat’s line. The request has no body.
Use this when an operator opens a conversation, or after your agent finishes handling inbound messages.

​
Request

POST /api/v1/chats/{id}/mark-read No request body. 
curl -X POST https://console.trychert.com/api/v1/chats/$CHAT_ID/mark-read \
  -H "x-chert-tenant: $TENANT" \
  -H "x-chert-signature: v1,$TS,$SIG" \
  -H "content-type: application/json"

​
Response

{
  "chat_id": "0f2d3c1a-8b4e-4f6a-90d2-1a3b4c5d6e7f",
  "status": "read"
}

​
Path parameters

​
id
string
required
The Chert chat_id of the chat to mark as read.

​
Response fields

​
chat_id
string
Echoed-back chat_id.
​
status
string
Always "read" on success.

​
Errors

CodeHTTPWhen
2002404Chat not found, or not owned by this tenant.
1002422Chat has no resolvable recipient.
4001502Delivery failed downstream.
4099501Mark-read is not available on this phone line.
See the full error code reference.

​
Notes

BehaviorWhat it means
Pinned line requiredThe receipt is emitted from the same line the chat is pinned to.
Existing chats onlyCreate or receive a chat first, then mark-read.
Read receipt visibilityThe recipient only sees a receipt when read receipts are enabled for the conversation.

​
See also