BINANCE SAPI · C2C

Mark Messages As Read By User and Order API

Update read status and clear unread message indicators across peer-to-peer (C2C) order chat sessions for the specified user and order identifier.

ENDPOINT
POST /sapi/v1/c2c/chat/markOrderMessagesAsRead
Authentication USER_DATA / SIGNED
API Group C2C / Chat
Method POST
Response JSON

Overview

This endpoint allows client applications, merchant management dashboards, and automated trading bots to acknowledge incoming chat messages within an active or completed C2C (P2P) order. By providing the order number (orderNo) and the target account user ID (userId), callers clear the unread notification badge and update read receipts for the counterparty.

Integrating this call inside automated notification pipelines ensures customer service consoles maintain synchronized unread counters across web, desktop, and mobile terminals.

01

Request Parameters

Parameters accepted in Body and HTTP Headers.

Parameter In Type Required Description
clientType Header STRING Required Client Device Type initiating the request (e.g., WEB, APP, WEB_MOBILE).
orderNo Body STRING Required Unique C2C order number identifier associated with the chat thread.
userId Body INT64 Optional Target account user identifier marking the conversation as read.
x-gray-env Header STRING Optional Environment flag identifier used for internal gray/stage testing.
x-trace-id Header STRING Optional Custom client trace ID for request lifecycle tracking and debugging.
x-user-id Header STRING Optional Target user identifier for context validation.
i
UI Notification State Sync

Trigger this endpoint automatically as soon as an operator or bot pulls new messages via websocket or polling endpoints to keep notification queues accurate.

02

Request Example

Example POST request using cURL to mark conversation messages as read.

cURL BASH
curl -X POST \
'https://api.binance.com/sapi/v1/c2c/chat/markOrderMessagesAsRead' \
-H 'clientType: WEB' \
-H 'Content-Type: application/json' \
-d '{
  "orderNo": "202608171234567890",
  "userId": 123456789
}'
03

Response

Example response returned on successful status update.

RESPONSE 200 OK
{
    "code": "000000",
    "message": "success",
    "data": null,
    "success": true
}

Response Fields

Field Type Description
code STRING Standard Binance status code ("000000" indicates success).
message STRING Response execution feedback or status message.
data NULL / VOID Void return payload on successful acknowledgment.
success BOOLEAN Indicates overall request execution result.
04

How It Works

Workflow for synchronizing chat read statuses.

01 Open Chat Thread User or system loads messages for an active order.
02 Send POST Request Pass orderNo and userId to /markOrderMessagesAsRead.
03 Server Update Binance server clears unread flags for this thread.
04 Clear Badges Client UI updates unread count badges to zero.

Common Use Cases

Unread Badge Synchronization

Clear notification counters automatically when an operator opens an active trade window in merchant software.

Bot Auto-Acknowledge

Allow automated conversational bots to mark processed customer inquiries as read after parsing keywords.

Multi-Agent Helpdesk Tools

Prevent duplicate operator replies by accurately reflecting read states across team member consoles.



💬
Telegram WhatsApp