favorite-unfavourite-a-room.md

Favorite/Unfavourite a Room

HTTP Method	URL	Requires Auth
POST	/api/v1/rooms.favorite	yes

Body Parameters

Key	Example Value	Description
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

Version	Description
0.64.0	Added