Skip to content

[Conversation] Mark As Read

  • Endpoint Path: /api/v2/conversation/mark-as-read
  • Method: PUT
  • Request: application/json

Headers Optional Parameter

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

Body Params

Parameter NameTypeRequiredDescription
typeStringrequiredconversation or message
conversationIdNumberoptional
messageIdsStringoptionalseparated by English commas for multiple id

Request Description

  • Choose either conversationId or messageIds to pass as a parameter, but not both.
  • type = conversation: Use the conversationId parameter to set the current conversation as read, not including messages within the conversation.
  • type = message: Use the messageIds 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