API Reference version 2

Update room

PUT/v2/room/{room_id_or_name}

Updates a room.

Authentication required, with scope admin_room.
Accessible by group clients, users.

Request body

Type Property Description Required?
string name

Name of the room

Valid length range: 1 - 50.

Required
string privacy

Whether the room is available for access by other users or not

Valid values: public, private.

Defaults to 'public'.

Required
boolean is_archived

Whether the room should be archived or not.

Defaults to false.

Required
boolean is_guest_accessible

Whether or not to enable guest access for this room.

Defaults to false.

Required
string topic

The new topic for the room.

Required
object owner

The room owner.

Required
str | int id

User ID or email address of the room's owner. Defaults to the current user

Required
boolean delegate_admin_visibility

Whether the room is visible to delegate admins. Leave null to use the group default

May be null.

204 No content

Notes

  • Changes are detected and applied sequentially in the following order: topic, guest access, privacy, name, owner, and archived status. If any fail, the previous changes will remain applied.