---
url: /apidocs/room_preset.md
---
## Room: Preset API

| Endpoint | Method | Description |
|-----|-----|-----|
| [room:createPresetArea](#create-preset-area) | websocket | Create preset area |
| [room:deletePresetArea](#delete-preset-area) | websocket | Delete preset area |
| [room:listPresetAreas](#list-preset-areas) | websocket | List preset areas |
| [room:getPresetAreaContent](#get-preset-area-content) | websocket | Get preset area content |
| [room:addPresetAreaPropsToRoom](#add-preset-area-props-to-room) | websocket | Add preset area props to room |
| [room:createPlacementArea](#create-placement-area) | websocket | Create placement area |
| [room:updatePlacementArea](#update-placement-area) | websocket | Update placement area |
| [room:updatePlacementAreaCompanyName](#update-placement-area-company-name) | websocket | Update placement area company name |
| [room:setPlacementAreaCustomization](#set-placement-area-customization) | websocket | Set placement area customization |
| [room:purchasePlacementArea](#purchase-placement-area) | websocket | Purchase placement area |
| [room:expirePlacementAreaSubscription](#expire-placement-area-subscription) | websocket | Expire placement area subscription |
| [room:deletePlacementArea](#delete-placement-area) | websocket | Delete placement area |
| [room:restorePlacementArea](#restore-placement-area) | websocket | Restore placement area |
| [room:placementAreaCreated](#event-placement-area-created) | websocketEvent | Event: placement area created |
| [room:placementAreaUpdated](#event-placement-area-updated) | websocketEvent | Event: placement area updated |
| [room:placementAreaDeleted](#event-placement-area-deleted) | websocketEvent | Event: placement area deleted |
| [room:presetAreaCreated](#event-preset-area-created) | websocketEvent | Event: preset area created |
| [room:presetAreaDeleted](#event-preset-area-deleted) | websocketEvent | Event: preset area deleted |
| [room:placementAreas](#placement-areas-event) | websocketEvent | Placement areas event |

### Create preset area

**Method:** websocket

**Endpoint:** room:createPresetArea

**Request:**

**Response:**

### Delete preset area

**Method:** websocket

**Endpoint:** room:deletePresetArea

**Request:**

**Response:**

### List preset areas

**Method:** websocket

**Endpoint:** room:listPresetAreas

**Description:** Api returns a list of all user preset areas.

**Request:**

**Response:**

### Get preset area content

**Method:** websocket

**Endpoint:** room:getPresetAreaContent

**Description:** Api returns preset area content.

**Request:**

**Response:**

### Add preset area props to room

**Method:** websocket

**Endpoint:** room:addPresetAreaPropsToRoom

**Description:** Api adds props from preset area to room. If `placementAreaId` provided - server will check if user can add props to a placement area instead of the room.

**Request:**

**Response:**

### Create placement area

**Method:** websocket

**Endpoint:** room:createPlacementArea

**Request:**

**Response:**

### Update placement area

**Method:** websocket

**Endpoint:** room:updatePlacementArea

**Request:**

**Response:**

### Update placement area company name

**Method:** websocket

**Endpoint:** room:updatePlacementAreaCompanyName

**Request:**

**Response:**

### Set placement area customization

**Method:** websocket

**Endpoint:** room:setPlacementAreaCustomization

**Request:**

**Response:**

### Purchase placement area

**Method:** websocket

**Endpoint:** room:purchasePlacementArea

**Request:**

**Response:**

### Expire placement area subscription

**Method:** websocket

**Endpoint:** room:expirePlacementAreaSubscription

**Request:**

**Response:**

### Delete placement area

**Method:** websocket

**Endpoint:** room:deletePlacementArea

**Request:**

**Response:**

### Restore placement area

**Method:** websocket

**Endpoint:** room:restorePlacementArea

**Request:**

**Response:**

### Event: placement area created

**Event:** room:placementAreaCreated

**Data:**

### Event: placement area updated

**Event:** room:placementAreaUpdated

**Data:**

### Event: placement area deleted

**Event:** room:placementAreaDeleted

**Data:**

### Event: preset area created

**Event:** room:presetAreaCreated

**Data:**

### Event: preset area deleted

**Event:** room:presetAreaDeleted

**Data:**

### Placement areas event

**Event:** room:placementAreas

**Description:** An event is triggered when a client requested for a room that has placement areas within.

**Data:**

## Models

#### Geometry

#### XYZ

#### Room Prop

#### Programmatic Action with children

#### Programmatic Action

#### 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

#### Asset Bundle Prop

#### Asset Bundle Skin

#### RGBA