Post
/api/v1/rooms.favorite
Mark/Unmark a room as favourite.
Changelog
| Version | Description |
|---|---|
| 0.64.0 | Added |
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Body parameters
Example
{
"roomId": "GENERAL",
"favorite": true
}object
roomId
string Required
The room ID. Alternatively, enter the roomName parameter and provide the room's name as the value. You must be a member of the room.
favorite
boolean Required
A boolean to mark the room as favourite or not.
Responses
200
OK
Success
{
"success": true
}object
success
boolean
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string