MAmatrix
Room upgrades

Upgrades a room to a new room version.

Upgrades the given room to a particular room version.

post/_matrix/client/v3/rooms/{roomId}/upgrade

Request

Path parameters

roomIdstring required

The ID of the room to upgrade.

Request body

additional_creatorsstring[]

When upgrading to a room version which supports additional creators, the user IDs which should be considered room creators in addition to the user performing the upgrade.

If the room being upgraded has additional creators, they are not automatically copied to the new room. The full set of additional creators needs to be set to retain (or add/remove) more room creators.

When upgrading to a room version which doesn't support additional creators, this field is ignored and has no effect during the upgrade process.

new_versionstring required

The new version for the room.

Example request

{
  "new_version": "2"
}

Response

The room was successfully upgraded.

replacement_roomstring required

The ID of the new room.

Changes

No recorded changes to this operation across all 1 revision of this API.