Star/Unstar Message (Realtime)

Prev Next

Starring messages enables users to save them easily for future reference or personal use.

Method

Requires Auth

Setting

starMessage

Yes

Message_AllowStarring

Payload parameters

Argument

Example

Required

Description

message

{
   "_id": "8gMsLe9ApZjo2D2iB",
   "rid": "64a1f373376181965ab77f54",
   "starred": true
}

Required

The message object.

The message object contains the following properties:

_id

8gMsLe9ApZjo2D2iB

Required

The message ID that you want to star or unstar.

rid

64a1f373376181965ab77f54

Required

The room ID.

starred

true

Required

It can only be true or false.

true: Star the message. false: Unstar the message.

Example call

{
    "msg": "method",
    "method": "starMessage",
    "id": "21",
    "params": [{
        "_id": "8gMsLe9ApZjo2D2iB",
        "rid": "64a1f373376181965ab77f54",
        "starred": true
    }]
}

Example response

{
    "msg": "result",
    "id": "21",
    "result": true
}