Star/Unstar Message

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

NameRequires AuthPermissionSetting

starMessage

Yes

Message_AllowStarring - "Allow Message Starring"

Payload Parameters

ArgumentExampleRequiredDescription

message

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

Required

The message object.

The message object contains the following properties:

_id

8gMsLe9ApZjo2D2iB

Required

The message id

rid

64a1f373376181965ab77f54

Required

The room id where the message should be sent

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
}

Last updated

Rocket.Chat versions receive support for six months after release.