Room

Update room organization ID

Changed on

This endpoint updates the room's organization ID. The fromOrganizationId must match the room's current organization ID. Returns the updated room.

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

Request

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

Path parameters

roomIdstring required

The ID of the room

Example:my-room-id

Request body

fromOrganizationIdstring required

The current organization ID of the room. Must match the room's current organization ID.

toOrganizationIdstring required

The new organization ID to assign to the room.

Example request

{
  "fromOrganizationId": "org_123456789",
  "toOrganizationId": "org_987654321"
}

Response

Success. Returns the updated room with the new organization 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

    • 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

    • 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