Links

Favorite/Unfavourite a Room

Favorite or unfavorite room.
Name
Requires Auth
Permission
Setting
toggleFavorite
Yes

Payload Parameters

Argument
Example
Required
Description
roomId
64a1f373376181965ab77f54
Required
The room id
favorite
false
Optional:
Default: true
true - Mark as favorite. false - Remove from favorite.

Example Call

{
"msg": "method",
"method": "toggleFavorite",
"id": "16",
"params": [
"64a1f540376181965ab77f5b",
false
]
}

Example Response

{
"msg": "result",
"id": "16",
"result": 1
}
Last modified 5mo ago
Rocket.Chat versions receive support for six months after release.