Updates the settings of an existing room.
For ABAC-managed rooms, the following guardrails apply:
- Changing
roomAnnouncement,roomTopic, orroomDescriptionis rejected witherror-action-not-allowed. - Setting
default: trueon an ABAC-managed room is rejected witherror-action-not-allowed. - Changing
roomTypefromptocis rejected witherror-action-not-allowed. The same guard applies to private rooms in ABAC-managed private teams. - When
roomTypechanges toc(public) and conversion is allowed, existing room ABAC attributes are cleared as part of the conversion.
Permission required: edit-room
Changelog
| Version | Description |
|---|---|
| 8.5.0 | Added ABAC guardrails: announcement, topic, description, default flag, and conversion to public are blocked on ABAC-managed rooms. |
| 3.13.0 | Added |
The authToken of the authenticated user.
The userId of the authenticated user.
{
"rid": "JZ8Y2dLfYhsg323Rf",
"roomName": "Test-Save-Room",
"roomDescription": "This is a test room."
}The room ID.
The name of the room.
The description of the room.
The base64 image.
Whether the room is featured or not.
The topic of the room.
The announcement of the room.
An object of the custom fields of the room.
The type of the room. It could be c for public rooms or p for private rooms.
Whether the room is read-only or not.
Whether users can react when the room is read-only.
The system messages that the room supports.
Whether the room is the default room or not.
The join code of the room.
The streaming options of the room.
Whether retention is enabled for the room or not.
The maximum age (in days) of messages to be retained in the room.
Whether to exclude pinned messages from retention or not.
Whether to retain only files in the room or not.
Whether to ignore threads when retaining messages or not.
Whether to override the global retention settings for the room or not.
Whether the room is encrypted or not.
The favorite settings of the room. Whether the room is marked as favorite and whether it is set as the default room.
List the team's channels or discussions to be displayed in the sidepanel.
The options are discussions and channels.
OK
{
"rid": "JZ8Y2dLfYhsg323Rf",
"success": true
}Bad Request
{
"success": false,
"error": "Invalid room [error-invalid-room]",
"errorType": "error-invalid-room"
}{
"success": false,
"error": "Changing an ABAC managed private room to public is not allowed [error-action-not-allowed]",
"errorType": "error-action-not-allowed",
"details": {
"method": "saveRoomSettings",
"action": "Change_Room_Type"
}
}{
"success": false,
"error": "Setting an ABAC managed room as default is not allowed [error-action-not-allowed]",
"errorType": "error-action-not-allowed",
"details": {
"method": "saveRoomSettings",
"action": "Viewing_room_administration"
}
}Unauthorized
{
"status": "error",
"message": "You must be logged in to do this."
}