Skip to content
Message Center

Update Message Read Status

Updates the read status of messages. Pass the parameters in the query string. Common uses:

  • Mark all as read: pass only clear_all=true to mark all messages of the current Client as read.
  • Mark a group as read: pass group_id and status=1 without ids to mark every message in the group as read. Call it when the Client opens a group.

After success, call GET /v6/message/inbox/unreads_count and GET /v6/message/inbox/groups/summary again to refresh the badge and the per-group unread counts. On failure, keep the local unread state and do not clear the badge in advance.

DELETEhttps://api.lbkrs.com/v6/message/inbox/clear_unreads

Parameters

clear_allbooleanquery

When true, marks all messages as read. No other parameter is needed

group_idintegerquery

ID of the message group to update, from list[].group_id of GET /v6/message/inbox/groups/summary

idsarrayquery

IDs of the messages to update, from list[].id of the message list. When omitted, the update applies to the whole group set by group_id

statusintegerquery

Target status. Pass it with group_id:

  • 1 - Read
  • 2 - Read by opening the message
  • -1 - Deleted

12-1

Responses

HTTP 200The request succeeded. A code of 0 means the message status was updated.
codeintegerrequired

Business status code, 0 indicates success

messagestringrequired

Human-readable result or error message.

Whale Docs