Links

Favorite/Unfavourite a Room

REST API Favorite Methods
Favorite or unfavorite room.
URL
Requires Auth
HTTP Method
/api/v1/rooms.favorite
yes
POST

Payload

Argument
Example
Required
Description
roomId
ByehQjC44FwMeiLbX
Required
The room's id
roomName
general
Optional
The roomName
favorite
true
Required
A boolean to mark as favourite or not

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
-H "Content-Type: application/json" \
http://localhost:3000/api/v1/rooms.favorite \
-d '{ "roomId": "GENERAL", "favorite": true }'

Example Result

{
"success": true
}

Change Log

Version
Description
0.64.0
Added
Last modified 1mo ago
Deprecation for cloud services and apps is now extended to November 20, 2023. Rocket.Chat versions receive support for six months after release.