Favorite/Unfavourite a Room

HTTP MethodURLRequires Auth

POST

/api/v1/rooms.favorite

Body Parameters

KeyExample ValueDescription

roomId* or roomName*

ByehQjC44FwMeiLbX

The room ID.

favorite*

true

A boolean to mark the room 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 Response

{
  "success": true
}

Change Log

VersionDescription

0.64.0

Added

Last updated

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