ROroblox
Universes

Update universe settings for an owned universe. V2 Contains data for avatar scale and asset override.

Changed on
patch/v2/universes/{universeId}/configuration

Request

  • Base URL
    https://develop.roblox.com
  • URL
    https://develop.roblox.com/v2/universes/{universeId}/configuration
  • Auth
    API key in cookie .ROBLOSECURITY

Path parameters

universeIdinteger required

The universeId.

Request body

allowPrivateServersboolean

If the universe allows the use of private servers.

privateServerPriceinteger

The price to purchase a private server in robux.

namestring

The name of the universe.

descriptionstring

The description of the universe.

promotionalTextstring

Promotional text for the universe. Empty stores an empty value.

universeAvatarType1 | 2 | 3

Which avatar types are allowed in the universe.

universeAnimationType1 | 2

Whether custom animations are allowed in the universe.

universeCollisionType1 | 2

What type of collisions are used by the universe.

universeJointPositioningType1 | 2

What avatar joint positioning type is allowed by the universe.

engineAvatarSettingsstring

Optional JSON string used to store avatar settings used by the game engine. Will not be updated if null or empty. To clear settings, set to empty JSON object "{}". Note: This is an experimental field which may be changed or removed in future.

isArchivedboolean

Archive status of the universe.

isFriendsOnlyboolean

Whether game access is limited to friends for user-owned games or group members for group-owned games.

genre0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14

Game genre.

playableDevicesinteger[]

List of device types this game can be played on.

isForSaleboolean

Whether the game is offered for sale.

priceinteger

Price of the game, in Robux.

studioAccessToApisAllowedboolean

Whether Studio can access data stores of this universe.

optInRegionsinteger[]

A list of opt in region.

optOutRegionsinteger[]

A list of opt out region.

isMeshTextureApiAccessAllowedboolean

Sets whether access to APIs for mesh and texture is enabled for this universe.

isRewardedOnDemandAdsAllowedboolean

Whether rewarded on-demand ads are allowed for this universe.

fiatBasePriceIdstring

Sets the base price of the experience for Fiat purchases.

fiatProductChangeType0 | 1 | 2 | 3

Determines the change type of the Fiat Product Change request. Can either Activate, Update Base Price, or Deactivate.

audiencesinteger[]

The audiences this universe should be visible to (e.g. Editors, PlayTesters, Friends, Public). When provided, replaces the universe's existing audience set with the supplied values.

demoModeEnabledboolean

Whether demo mode is enabled for this paid access game.

Response

OK

allowPrivateServersboolean

If the universe allows the use of private servers.

privateServerPriceinteger

The price to purchase a private server in robux.

isMeshTextureApiAccessAllowedboolean

Whether access to APIs for mesh and texture is enabled for this universe.

isRewardedOnDemandAdsAllowedboolean

Whether rewarded on-demand ads are allowed for this universe.

idinteger

The universe Id.

namestring

The universe name.

descriptionstring

The universe description.

promotionalTextstring

Promotional Text for the universe.

universeAvatarType1 | 2 | 3

Which avatar types are allowed in the universe. ['MorphToR6' = 1, 'PlayerChoice' = 2, 'MorphToR15' = 3]

universeAnimationType1 | 2

Whether custom animations are allowed in the universe. ['Standard' = 1, 'PlayerChoice' = 2]

universeCollisionType1 | 2

What type of collisions are used by the universe. ['InnerBox' = 1, 'OuterBox' = 2]

universeJointPositioningType1 | 2

What avatar joint positioning is allowed by the universe. ['Standard' = 1, 'ArtistIntent' = 2]

engineAvatarSettingsstring

Optional JSON string used to store avatar settings used by the game engine. Note: This is an experimental field which may be changed or removed in future.

isArchivedboolean

Archive status of the universe

isFriendsOnlyboolean

Whether game access is limited to friends for user-owned games or group members for group-owned games.

genre0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14

Game genre. ['All' = 0, 'Tutorial' = 1, 'Scary' = 2, 'TownAndCity' = 3, 'War' = 4, 'Funny' = 5, 'Fantasy' = 6, 'Adventure' = 7, 'SciFi' = 8, 'Pirate' = 9, 'FPS' = 10, 'RPG' = 11, 'Sports' = 12, 'Ninja' = 13, 'WildWest' = 14]

playableDevicesinteger[]

List of device types this game can be played on.

isForSaleboolean

Whether the game is offered for sale.

priceinteger

Price of the game, in Robux.

studioAccessToApisAllowedboolean

Whether Studio can access data stores of this universe.

isForSaleInFiatboolean

Whether the game is offered for sale in fiat.

fiatBasePriceIdstring

The basePriceId for the Fiat product.

fiatModerationStatus0 | 1 | 2 | 3 | 4

The current moderation status of the game if it is for sale in fiat. ['Invalid' = 0, 'NotModerated' = 1, 'Pending' = 2, 'Approved' = 3, 'Rejected' = 4]

audiencesinteger[]

The audiences this universe is visible to (e.g. Editors, PlayTesters, Friends, Public). Always non-null; may be empty when audience visibility has not been configured.

demoModeEnabledboolean

Whether demo mode is enabled.

demoModeChangeableAfterstring date-time

The earliest time at which demo mode can be toggled again (ISO 8601). Null when no cooldown is active (i.e. demo mode can be changed immediately).

Changes

  • 3fe4a685dcbcRevision changes
    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)