Update Universe
Updates the specified universe.
This method is guaranteed to return all updated fields. This method may additionally return the full resource.
Request
- Base URLhttps://apis.roblox.com
- Auth
- API key in header x-api-key
- or OAuth 2Authorization codehttps://apis.roblox.com/oauth/v1/authorizeToken URLhttps://apis.roblox.com/oauth/v1/tokenScopesuniverse:write
Path parameters
The universe ID.
Query parameters
The list of fields to update.
Request body
The resource path of the universe.
Format: universes/{universe_id}
The timestamp when the universe was created.
The timestamp when the universe was last updated.
The name of the universe.
This field can be updated by updating the root place's name.
The description of the universe.
This field can be updated by updating the root place's description.
The universe is user-owned.
The universe is group-owned.
Represents whether or not the Universe is publicly accessible.
Whether or not voice chat is enabled for users in the Experience.
Updating this value will not affect active servers.
Supported age ratings for the universe. This field is read only.
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.
Whether or not players can join the Experience via Desktop.
Whether or not players can join the Experience via Mobile.
Whether or not players can join the Experience via Tablet.
Whether or not players can join the Experience via Console.
Whether or not players can join the Experience via VR.
The resource path of the root place of this universe Format: universes/{universe_id}/places/{place_id}
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}
Response
OK
The resource path of the universe.
Format: universes/{universe_id}
The timestamp when the universe was created.
The timestamp when the universe was last updated.
The name of the universe.
This field can be updated by updating the root place's name.
The description of the universe.
This field can be updated by updating the root place's description.
The universe is user-owned.
The universe is group-owned.
Represents whether or not the Universe is publicly accessible.
Whether or not voice chat is enabled for users in the Experience.
Updating this value will not affect active servers.
Supported age ratings for the universe. This field is read only.
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.
Whether or not players can join the Experience via Desktop.
Whether or not players can join the Experience via Mobile.
Whether or not players can join the Experience via Tablet.
Whether or not players can join the Experience via Console.
Whether or not players can join the Experience via VR.
The resource path of the root place of this universe Format: universes/{universe_id}/places/{place_id}
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}
Changes
No recorded changes to this operation across all 35 revisions of this API.