---
title: "Upgrades a room to a new room version."
method: POST
path: "/_matrix/client/v3/rooms/{roomId}/upgrade"
tags: ["Room upgrades"]
---

# Upgrades a room to a new room version.

`POST /_matrix/client/v3/rooms/{roomId}/upgrade`

## Request

- Base URL: `https://matrix.org`
- URL: `https://matrix.org/_matrix/client/v3/rooms/{roomId}/upgrade`
- Auth: one of:
  - API key in query parameter `access_token`
  - HTTP bearer
- TypeScript: <https://skmtc.dev/matrix/apis/matrix-client-server-api/docs/_matrix/client/v3/rooms/:roomId/upgrade/post.ts> (a function with typed inputs; its response is checked against the schema)

Upgrades the given room to a particular room version.

## Path parameters

- `roomId` string, required

## Request body

- object
  - `additional_creators` string[]: When upgrading to a [room version](https://spec.matrix.org/v1.19/rooms) which supports additional creators, the [user IDs](https://spec.matrix.org/v1.19/appendices#user-identifiers) 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_version` string, required: The new version for the room.

## Response `200`

The room was successfully upgraded.

- object
  - `replacement_room` string, required: The ID of the new room.

## Other responses

- `400`: The request was invalid. One way this can happen is if the room version requested is not supported by the homeserver.
- `403`: The user is not permitted to upgrade the room.

---

[API](https://skmtc.dev/matrix/apis/matrix-client-server-api.md) - [All operations](https://skmtc.dev/matrix/apis/matrix-client-server-api/llms.txt) - [OpenAPI document](https://skmtc.dev/matrix/apis/matrix-client-server-api/revisions/c7fe4072c681?raw)
