ROroblox
Universes

Update Universe

Changed on

Updates the specified universe.

This method is guaranteed to return all updated fields. This method may additionally return the full resource.

patch/cloud/v2/universes/{universe_id}

Request

  • Base URL
    https://apis.roblox.com
  • URL
    https://apis.roblox.com/cloud/v2/universes/{universe_id}
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization code: https://apis.roblox.com/oauth/v1/authorize
      Token URL: https://apis.roblox.com/oauth/v1/token scopes: universe:write

Path parameters

universe_idstring required

The universe ID.

Query parameters

updateMaskstring field-mask

The list of fields to update.

Request body

pathstring

The resource path of the universe.

Format: universes/{universe_id}

createTimestring date-time

The timestamp when the universe was created.

updateTimestring date-time

The timestamp when the universe was last updated.

displayNamestring

The name of the universe.

This field can be updated by updating the root place's name.

descriptionstring

The description of the universe.

This field can be updated by updating the root place's description.

userstring

The universe is user-owned.

groupstring

The universe is group-owned.

visibility'VISIBILITY_UNSPECIFIED' | 'PUBLIC' | 'PRIVATE' enum

Whether or not the universe is publicly accessible.

Possible values:

ValueDescription
VISIBILITY_UNSPECIFIEDUpdates using this value will throw an error on the backend.
PUBLICThe universe is public.
PRIVATEThe universe is private. If a universe's visibility is set to PRIVATE, all active players will immediately be removed from all running servers.
voiceChatEnabledboolean

Whether or not voice chat is enabled for users in the Experience.

Updating this value will not affect active servers.

ageRating'AGE_RATING_UNSPECIFIED' | 'AGE_RATING_ALL' | 'AGE_RATING_9_PLUS' | 'AGE_RATING_13_PLUS' | 'AGE_RATING_17_PLUS' enum

The age rating of this universe.

Possible values:

ValueDescription
AGE_RATING_UNSPECIFIEDThe age rating is not set.
AGE_RATING_ALLSupported for all users.
AGE_RATING_9_PLUSSupported for users aged 9 and up.
AGE_RATING_13_PLUSSupported for users aged 13 and up.
AGE_RATING_17_PLUSSupported for users aged 17 and up.
privateServerPriceRobuxinteger

Represents the price in Robux of private servers.

If unset, private servers are not supported for this universe.

Can only be disabled when using a field mask.

Setting to null will disable all active private servers.

Changing the price will cancel all private server subscriptions.

desktopEnabledboolean

Whether or not players can join the Experience via Desktop.

mobileEnabledboolean

Whether or not players can join the Experience via Mobile.

tabletEnabledboolean

Whether or not players can join the Experience via Tablet.

consoleEnabledboolean

Whether or not players can join the Experience via Console.

vrEnabledboolean

Whether or not players can join the Experience via VR.

rootPlacestring

The resource path of the root place of this universe Format: universes/{universe_id}/places/{place_id}

templateRootPlacestring required

The resource path of the template place, used for CreateUniverse. The root place of the newly-created universe 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",
  "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!",
  "visibility": "VISIBILITY_UNSPECIFIED",
  "voiceChatEnabled": true,
  "ageRating": "AGE_RATING_UNSPECIFIED",
  "desktopEnabled": true,
  "mobileEnabled": true,
  "tabletEnabled": true,
  "consoleEnabled": true,
  "vrEnabled": true,
  "templateRootPlace": "universes/{universe_id}/places/{place_id}"
}

Response

OK

pathstring

The resource path of the universe.

Format: universes/{universe_id}

createTimestring date-time

The timestamp when the universe was created.

updateTimestring date-time

The timestamp when the universe was last updated.

displayNamestring

The name of the universe.

This field can be updated by updating the root place's name.

descriptionstring

The description of the universe.

This field can be updated by updating the root place's description.

userstring

The universe is user-owned.

groupstring

The universe is group-owned.

visibility'VISIBILITY_UNSPECIFIED' | 'PUBLIC' | 'PRIVATE' enum

Whether or not the universe is publicly accessible.

Possible values:

ValueDescription
VISIBILITY_UNSPECIFIEDUpdates using this value will throw an error on the backend.
PUBLICThe universe is public.
PRIVATEThe universe is private. If a universe's visibility is set to PRIVATE, all active players will immediately be removed from all running servers.
voiceChatEnabledboolean

Whether or not voice chat is enabled for users in the Experience.

Updating this value will not affect active servers.

ageRating'AGE_RATING_UNSPECIFIED' | 'AGE_RATING_ALL' | 'AGE_RATING_9_PLUS' | 'AGE_RATING_13_PLUS' | 'AGE_RATING_17_PLUS' enum

The age rating of this universe.

Possible values:

ValueDescription
AGE_RATING_UNSPECIFIEDThe age rating is not set.
AGE_RATING_ALLSupported for all users.
AGE_RATING_9_PLUSSupported for users aged 9 and up.
AGE_RATING_13_PLUSSupported for users aged 13 and up.
AGE_RATING_17_PLUSSupported for users aged 17 and up.
privateServerPriceRobuxinteger

Represents the price in Robux of private servers.

If unset, private servers are not supported for this universe.

Can only be disabled when using a field mask.

Setting to null will disable all active private servers.

Changing the price will cancel all private server subscriptions.

desktopEnabledboolean

Whether or not players can join the Experience via Desktop.

mobileEnabledboolean

Whether or not players can join the Experience via Mobile.

tabletEnabledboolean

Whether or not players can join the Experience via Tablet.

consoleEnabledboolean

Whether or not players can join the Experience via Console.

vrEnabledboolean

Whether or not players can join the Experience via VR.

rootPlacestring

The resource path of the root place of this universe Format: universes/{universe_id}/places/{place_id}

templateRootPlacestring required

The resource path of the template place, used for CreateUniverse. The root place of the newly-created universe 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 response

{
  "path": "universes/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!",
  "visibility": "VISIBILITY_UNSPECIFIED",
  "voiceChatEnabled": true,
  "ageRating": "AGE_RATING_UNSPECIFIED",
  "desktopEnabled": true,
  "mobileEnabled": true,
  "tabletEnabled": true,
  "consoleEnabled": true,
  "vrEnabled": true,
  "templateRootPlace": "universes/{universe_id}/places/{place_id}"
}

Changes