v1

latestOpenAPI 3.0.42026-08-068161,1253.1 MB

Places

Universes

Update Place

Updates the specified place. To avoid overwriting changes, this endpoint responds with an HTTP 409 Conflict error if the place is open in an active Team Create session.

patch/cloud/v2/universes/{universe_id}/places/{place_id}

Path parameters

universe_idstring required

The universe ID.

place_idstring required

The place ID.

Query parameters

updateMaskstring field-mask

The list of fields to update.

Request body

pathstring

The resource path of the place.

Format: universes/{universe_id}/places/{place_id}

createTimestring date-time

The timestamp at which the place was created.

updateTimestring date-time

The timestamp at which the place was updated.

displayNamestring

The name of the place.

descriptionstring

The description of the place.

serverSizeinteger

The maximum number of allowed users in a single server.

rootboolean

Whether this place is its parent universe's root place or not. Each universe has exactly one root place.

universeRuntimeCreationboolean

Whether this place was created through in-experience creation. If true, the place was created by calling AssetService::CreatePlaceAsync() from a script.

templatePlacestring required

The resource path of the template place used to initialize the place on creation. The newly created place will be a clone of this template. A list of the valid template places can be obtained from ListTemplatePlaces. Format: universes/{universe_id}/places/{place_id}

Example request

{
  "path": "universes/123/places/123",
  "createTime": "2023-07-05T12:34:56Z",
  "updateTime": "2023-07-05T12:34:56Z",
  "displayName": "ROBLOX Battle [OPEN]",
  "description": "OPEN SOURCE! \n Feel free to check out how we made this game and ask us about it!",
  "root": true,
  "universeRuntimeCreation": true,
  "templatePlace": "universes/{universe_id}/places/{place_id}"
}

Response