Room

Update room ID

Changed on Jun 29, 2026

This endpoint permanently updates the room’s ID. All existing references to the old room ID will need to be updated. Returns the updated room. Corresponds to liveblocks.updateRoomId.

post/rooms/{roomId}/update-room-id

Request

Base URL: https://api.liveblocks.io/v2
URL: https://api.liveblocks.io/v2/rooms/{roomId}/update-room-id
Auth: none declared

Path parameters

roomIdstring required

The new ID for the room

Example:my-room-id

Request body

newRoomIdstring required

The new room ID

Example request

{
  "newRoomId": "new-room-id"
}

Response

Success. Returns the updated room with the new ID.

idstring required

type'room' required

organizationIdstring required

The organization ID associated with this room.

lastConnectionAtstring date-time

createdAtstring date-time required

defaultAccessesRoomPermissionItem[] required

usersAccessesRoomAccesses required

groupsAccessesRoomAccesses required

metadataRoomMetadata required

Example response

{
  "type": "room",
  "id": "my-room-id",
  "lastConnectionAt": "2022-08-04T21:07:09.380Z",
  "createdAt": "2022-07-13T14:32:50.697Z",
  "organizationId": "org_123456789",
  "metadata": {
    "color": "blue",
    "type": "whiteboard"
  },
  "defaultAccesses": [
    "*:write"
  ],
  "groupsAccesses": {
    "marketing": [
      "*:write"
    ]
  },
  "usersAccesses": {
    "alice": [
      "*:write"
    ]
  }
}

Changes

Jun 29, 2026e66e044110f9 Revision changes
- warning
  added the new comments:private:none enum value to the / response property for the response status
- warning
  added the new comments:private:none enum value to the // response property for the response status
- warning
  added the new comments:private:none enum value to the // response property for the response status
- warning
  added the new comments:private:read enum value to the / response property for the response status
- warning
  added the new comments:private:read enum value to the // response property for the response status
- warning
  added the new comments:private:read enum value to the // response property for the response status
- warning
  added the new comments:private:write enum value to the / response property for the response status
- warning
  added the new comments:private:write enum value to the // response property for the response status
- warning
  added the new comments:private:write enum value to the // response property for the response status
- warning
  added the new comments:public:none enum value to the / response property for the response status
- warning
  added the new comments:public:none enum value to the // response property for the response status
- warning
  added the new comments:public:none enum value to the // response property for the response status
- warning
  added the new comments:public:read enum value to the / response property for the response status
- warning
  added the new comments:public:read enum value to the // response property for the response status
- warning
  added the new comments:public:read enum value to the // response property for the response status
- warning
  added the new comments:public:write enum value to the / response property for the response status
- warning
  added the new comments:public:write enum value to the // response property for the response status
- warning
  added the new comments:public:write enum value to the // response property for the response status
Jun 17, 2026f7ddea756395 Revision changes
- warning
  added the new *:read enum value to the / response property for the response status
- warning
  added the new *:read enum value to the // response property for the response status
- warning
  added the new *:read enum value to the // response property for the response status
- warning
  added the new *:write enum value to the / response property for the response status
- warning
  added the new *:write enum value to the // response property for the response status
- warning
  added the new *:write enum value to the // response property for the response status
- warning
  added the new comments:none enum value to the / response property for the response status
- warning
  added the new comments:none enum value to the // response property for the response status
- warning
  added the new comments:none enum value to the // response property for the response status
- warning
  added the new comments:read enum value to the / response property for the response status
- warning
  added the new comments:read enum value to the // response property for the response status
- warning
  added the new comments:read enum value to the // response property for the response status
- warning
  added the new feeds:none enum value to the / response property for the response status
- warning
  added the new feeds:none enum value to the // response property for the response status
- warning
  added the new feeds:none enum value to the // response property for the response status
- warning
  added the new feeds:read enum value to the / response property for the response status
- warning
  added the new feeds:read enum value to the // response property for the response status
- warning
  added the new feeds:read enum value to the // response property for the response status
- warning
  added the new feeds:write enum value to the / response property for the response status
- warning
  added the new feeds:write enum value to the // response property for the response status
- warning
  added the new feeds:write enum value to the // response property for the response status
- warning
  added the new storage:none enum value to the / response property for the response status
- warning
  added the new storage:none enum value to the // response property for the response status
- warning
  added the new storage:none enum value to the // response property for the response status
- warning
  added the new storage:read enum value to the / response property for the response status
- warning
  added the new storage:read enum value to the // response property for the response status
- warning
  added the new storage:read enum value to the // response property for the response status
- warning
  added the new storage:write enum value to the / response property for the response status
- warning
  added the new storage:write enum value to the // response property for the response status
- warning
  added the new storage:write enum value to the // response property for the response status

Operation history (5 revisions)