Skip to content

[Conversation] Mark As Read

  • Endpoint Path: /api/fresns/v1/conversation/{uidOrUsername}/read-status
  • Method: PATCH
  • Request: Rest + application/json

Headers Optional Parameter

KeyPublic Mode (Required)Private Mode (Required)
X-Fresns-Aidrequiredrequired
X-Fresns-Aid-Tokenrequiredrequired
X-Fresns-Uidrequiredrequired
X-Fresns-Uid-Tokenrequiredrequired

Path Variables

KeyTypeRequiredDescription
uidOrUsernameNumber / StringrequiredUser uid or username

Body Params

KeyTypeRequiredDescription
cmidsStringoptionalseparated by English commas for multiple cmid

Request Description

  • cmids Leave null to mark the entire conversation as read.
  • Use the cmids parameter to set specified ID messages as read in bulk.

Return

json
{
    "code": 0,
    "message": "ok",
    "data": null
}

Released under the Apache-2.0 License