---
url: /apidocs/adminserver_room.md
---
## Admin Room API

| Endpoint | Method | Description |
|-----|-----|-----|
| [/files/parseRoomBoothsSpreadsheet](#parse-room-booths-spreadsheet) | webRequest | Parse room booths spreadsheet |
| [/files/parseBoothsMembersSpreadsheet/{roomId}](#parse-booths-members-spreadsheet) | webRequest | Parse booths members spreadsheet |
| [/files/generateRoomBoothsSpreadsheet/{roomId}](#generate-room-booths-spreadsheet) | webRequest | Generate room booths spreadsheet |
| [/files/updateRoomBoothsFromSpreadsheet](#update-room-booths-from-spreadsheet) | webRequest | Update room booths from spreadsheet |
| [/files/updateBoothsMembersFromSpreadsheet/{roomId}](#update-booths-members-from-spreadsheet) | webRequest | Update booths members from spreadsheet |
| [/jsonRpc/room.getRoomModel](#get-room-model) | jsonRpc | Get room model |
| [/jsonRpc/room.updateRoomMetadata](#update-room-metadata) | jsonRpc | Update room metadata |
| [/jsonRpc/room.updateRoomPrice](#update-room-price) | jsonRpc | Update room price |
| [/jsonRpc/room.deleteRoom](#delete-room) | jsonRpc | Delete room |
| [/jsonRpc/room.updateRoomExplorerStatus](#update-room-explorer-status) | jsonRpc | Update room explorer status |
| [/jsonRpc/room.updateRoomFeaturingScore](#update-room-featuring-score) | jsonRpc | Update room featuring score |
| [/jsonRpc/room.updateRoomFeaturingBoost](#update-room-featuring-boost) | jsonRpc | Update room featuring boost |
| [/jsonRpc/room.setRoomAlias](#set-room-alias) | jsonRpc | Set room alias |
| [/jsonRpc/room.deleteRoomAlias](#delete-room-alias) | jsonRpc | Delete room alias |
| [/jsonRpc/room.expireRoomSubscription](#expire-room-subscription) | jsonRpc | Expire room subscription |
| [/jsonRpc/room.createNewRoomSubscription](#create-new-room-subscription) | jsonRpc | Create new room subscription |
| [/jsonRpc/room.listRooms](#list-rooms) | jsonRpc | List rooms |
| [/jsonRpc/room.searchRooms](#search-rooms) | jsonRpc | Search rooms |
| [/jsonRpc/room.listUserRooms](#list-user-rooms) | jsonRpc | List user rooms |
| [/jsonRpc/room.listUserAvailableRooms](#list-user-available-rooms) | jsonRpc | List user available rooms |
| [/jsonRpc/room.searchUserAvailableRooms](#search-user-available-rooms) | jsonRpc | Search user available rooms |
| [/jsonRpc/room.listUserProps](#list-user-props) | jsonRpc | List user props |
| [/jsonRpc/room.listProps](#list-props) | jsonRpc | List props |
| [/jsonRpc/room.listRoomProps](#list-room-props) | jsonRpc | List room props |
| [/jsonRpc/room.listRoomBooths](#list-room-booths) | jsonRpc | List room booths |
| [/jsonRpc/room.addRoomOwner](#add-room-owner) | jsonRpc | Add room owner |
| [/jsonRpc/room.getPropInvitations](#get-prop-invitations) | jsonRpc | Get prop invitations |
| [/jsonRpc/room.inviteToProp](#invite-to-prop) | jsonRpc | Invite to prop |
| [/jsonRpc/room.deletePropInvitation](#delete-prop-invitation) | jsonRpc | Delete prop invitation |
| [/jsonRpc/room.setPropTeamMemberByEmail](#set-prop-team-member-by-email) | jsonRpc | Set prop team member by email |
| [/jsonRpc/room.setPropTitle](#set-prop-title) | jsonRpc | Set prop title |
| [/jsonRpc/room.copyRoom](#copy-room) | jsonRpc | Copy room |
| [/jsonRpc/room.getSortingTable](#get-sorting-table) | jsonRpc | Get sorting table |
| [/jsonRpc/room.deleteResourcesFromSortingTable](#delete-resources-from-sorting-table) | jsonRpc | Delete resources from sorting table |
| [/jsonRpc/room.getTemplateStyles](#get-template-styles) | jsonRpc | Get template styles |
| [/jsonRpc/room.getTemplateRooms](#get-template-rooms) | jsonRpc | Get template rooms |
| [/jsonRpc/room.setRoomAsTemplate](#set-room-as-template) | jsonRpc | Set room as template |
| [/jsonRpc/room.unsetRoomTemplate](#unset-room-template) | jsonRpc | Unset room template |

### Parse room booths spreadsheet

**HTTP Method:** POST

**Path:** /files/parseRoomBoothsSpreadsheet

**Permissions:**

network.manage /networkId

**Request:**

**Response:**

### Parse booths members spreadsheet

**HTTP Method:** POST

**Path:** /files/parseBoothsMembersSpreadsheet/{roomId}

**Permissions:**

network.manage /networkId

**Request:**

**Response:**

### Generate room booths spreadsheet

**HTTP Method:** GET

**Path:** /files/generateRoomBoothsSpreadsheet/{roomId}

**Permissions:**

network.manage /networkId

**Request:**

**Response:**

### Update room booths from spreadsheet

**HTTP Method:** POST

**Path:** /files/updateRoomBoothsFromSpreadsheet

**Permissions:**

network.manage /networkId

**Request:**

**Response:**

### Update booths members from spreadsheet

**HTTP Method:** POST

**Path:** /files/updateBoothsMembersFromSpreadsheet/{roomId}

**Permissions:**

network.manage /networkId

**Request:**

**Response:**

### Get room model

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/room.getRoomModel

**Permissions:**

network.manage /networkId

room.manage /networkId/roomId

**Request:**

**Response:**

### Update room metadata

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/room.updateRoomMetadata

**Permissions:**

network.manage /networkId

room.manage /networkId/roomId

**Request:**

**Response:**

### Update room price

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/room.updateRoomPrice

**Permissions:**

network.manage /networkId

room.manage /networkId/roomId

**Request:**

**Response:**

### Delete room

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/room.deleteRoom

**Permissions:**

network.manage /networkId

room.manage /networkId/roomId

**Request:**

**Response:**

### Update room explorer status

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/room.updateRoomExplorerStatus

**Permissions:**

network.manage /networkId

**Request:**

**Response:**

### Update room featuring score

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/room.updateRoomFeaturingScore

**Permissions:**

network.manage /networkId

**Request:**

**Response:**

### Update room featuring boost

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/room.updateRoomFeaturingBoost

**Permissions:**

network.manage /networkId

**Request:**

**Response:**

### Set room alias

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/room.setRoomAlias

**Permissions:**

network.manage /networkId

**Request:**

**Response:**

### Delete room alias

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/room.deleteRoomAlias

**Permissions:**

network.manage /networkId

**Request:**

**Response:**

### Expire room subscription

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/room.expireRoomSubscription

**Permissions:**

network.manage /networkId

**Request:**

**Response:**

### Create new room subscription

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/room.createNewRoomSubscription

**Permissions:**

network.manage /networkId

**Request:**

**Response:**

### List rooms

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/room.listRooms

**Permissions:**

network.manage /networkId

**Request:**

**Response:**

### Search rooms

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/room.searchRooms

**Permissions:**

network.manage /networkId

**Request:**

**Response:**

### List user rooms

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/room.listUserRooms

**Request:**

**Response:**

### List user available rooms

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/room.listUserAvailableRooms

**Request:**

**Response:**

### Search user available rooms

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/room.searchUserAvailableRooms

**Request:**

**Response:**

### List user props

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/room.listUserProps

**Description:** Api returns list of user props (according to filter parameters).

**Request:**

**Response:**

### List props

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/room.listProps

**Description:** Api returns list of all network props (according to filter parameters).

**Permissions:**

network.manage /networkId

room.manage /networkId/roomId

**Request:**

**Response:**

### List room props

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/room.listRoomProps

**Permissions:**

network.manage /networkId

room.manage /networkId/roomId

**Request:**

**Response:**

### List room booths

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/room.listRoomBooths

**Permissions:**

network.manage /networkId

room.manage /networkId/roomId

**Request:**

**Response:**

### Add room owner

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/room.addRoomOwner

**Permissions:**

network.manage /networkId

room.manage /networkId/roomId

**Request:**

**Response:**

### Get prop invitations

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/room.getPropInvitations

**Permissions:**

network.manage /networkId

room.manage /networkId/roomId

prop.manage /networkId/roomId/propId

**Request:**

**Response:**

### Invite to prop

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/room.inviteToProp

**Permissions:**

network.manage /networkId

room.manage /networkId/roomId

prop.manage /networkId/roomId/propId

**Request:**

**Response:**

### Delete prop invitation

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/room.deletePropInvitation

**Permissions:**

network.manage /networkId

room.manage /networkId/roomId

prop.manage /networkId/roomId/propId

**Request:**

**Response:**

### Set prop team member by email

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/room.setPropTeamMemberByEmail

**Permissions:**

network.manage /networkId

room.manage /networkId/roomId

prop.manage /networkId/roomId/propId

**Request:**

**Response:**

### Set prop title

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/room.setPropTitle

**Permissions:**

network.manage /networkId

room.manage /networkId/roomId

prop.manage /networkId/roomId/propId

**Request:**

**Response:**

### Copy room

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/room.copyRoom

**Permissions:**

room.copy

**Request:**

**Response:**

### Get sorting table

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/room.getSortingTable

**Permissions:**

network.manage /networkId

room.manage /networkId/roomId

**Request:**

**Response:**

### Delete resources from sorting table

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/room.deleteResourcesFromSortingTable

**Permissions:**

network.manage /networkId

room.manage /networkId/roomId

**Request:**

**Response:**

### Get template styles

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/room.getTemplateStyles

**Permissions:**

network.manage /networkId

**Request:**

**Response:**

### Get template rooms

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/room.getTemplateRooms

**Permissions:**

network.manage /networkId

**Request:**

**Response:**

### Set room as template

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/room.setRoomAsTemplate

**Permissions:**

network.manage /networkId

**Request:**

**Response:**

### Unset room template

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /jsonRpc/room.unsetRoomTemplate

**Permissions:**

network.manage /networkId

**Request:**

**Response:**

## Models

#### Room

#### Resource

#### Resource Origin

#### Geolocation

#### Dimensions

#### Resource Data Audio

#### Resource Data Video

#### Resource Data Amazon

#### Resource Data Imdb

#### Resource Data Youtube

#### Resource Data Vimeo

#### Resource Data Pinterest

#### Resource Data Pixabay

#### Resource Data Facebook

#### Resource Data Remote Url

#### Live Stream Data

#### AI Generation Data

#### Resource Data Directory

#### Google Drive

#### Channel Data

#### Enrichment Data

#### Programmatic Action with children

#### Programmatic Action

#### Room Style

#### Room Panel

#### Geometry

#### XYZ

#### Room Prop

#### User Simple

#### Storyline

#### Camera Position

#### XYZW

#### Featuring

#### Prop Invitation Info