6 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

Roblox.Api.Develop.Models.UniverseSettingsRequestV2 — openapi

Model for UniverseSettings patch requests

Properties

Related Schemas

• Roblox.Platform.UniverseSettings.UniverseAvatarAssetOverrideResponseModel

• Roblox.Web.Responses.Avatar.ScaleModel

• Roblox.UniversePluginPermissionAuthority.Models.UniversePluginPermissions

Complete Schema

{
  "description": "Model for UniverseSettings patch requests",
  "type": "object",
  "properties": {
    "allowPrivateServers": {
      "description": "If the universe allows the use of private servers.",
      "type": "boolean"
    },
    "privateServerPrice": {
      "format": "int64",
      "description": "The price to purchase a private server in robux.",
      "type": "integer"
    },
    "name": {
      "description": "The name of the universe.",
      "type": "string"
    },
    "description": {
      "description": "The description of the universe.",
      "type": "string"
    },
    "promotionalText": {
      "description": "Promotional text for the universe. Empty stores an empty value.",
      "type": "string"
    },
    "universeAvatarType": {
      "format": "int32",
      "description": "Which avatar types are allowed in the universe.",
      "enum": [
        1,
        2,
        3
      ],
      "type": "integer"
    },
    "universeAnimationType": {
      "format": "int32",
      "description": "Whether custom animations are allowed in the universe.",
      "enum": [
        1,
        2
      ],
      "type": "integer"
    },
    "universeCollisionType": {
      "format": "int32",
      "description": "What type of collisions are used by the universe.",
      "enum": [
        1,
        2
      ],
      "type": "integer"
    },
    "universeJointPositioningType": {
      "format": "int32",
      "description": "What avatar joint positioning type is allowed by the universe.",
      "enum": [
        1,
        2
      ],
      "type": "integer"
    },
    "engineAvatarSettings": {
      "description": "Optional JSON string used to store avatar settings used by the game engine.\r\nWill not be updated if null or empty. To clear settings, set to empty JSON object \"{}\".\r\nNote: This is an experimental field which may be changed or removed in future.",
      "type": "string"
    },
    "isArchived": {
      "description": "Archive status of the universe.",
      "type": "boolean"
    },
    "isFriendsOnly": {
      "description": "Whether game access is limited to friends for user-owned games or group members for group-owned games.",
      "type": "boolean"
    },
    "genre": {
      "format": "int32",
      "description": "Game genre.",
      "enum": [
        0,
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9,
        10,
        11,
        12,
        13,
        14
      ],
      "type": "integer"
    },
    "playableDevices": {
      "description": "List of device types this game can be played on.",
      "type": "array",
      "items": {
        "format": "int32",
        "description": " ['Computer' = 1, 'Phone' = 2, 'Tablet' = 3, 'Console' = 4, 'VR' = 5, 'TV' = 6]",
        "enum": [
          1,
          2,
          3,
          4,
          5,
          6
        ],
        "type": "integer"
      }
    },
    "isForSale": {
      "description": "Whether the game is offered for sale.",
      "type": "boolean"
    },
    "price": {
      "format": "int64",
      "description": "Price of the game, in Robux.",
      "type": "integer"
    },
    "universeAvatarAssetOverrides": {
      "description": "A list of avatar asset overrides.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Roblox.Platform.UniverseSettings.UniverseAvatarAssetOverrideResponseModel"
      }
    },
    "universeAvatarMinScales": {
      "$ref": "#/components/schemas/Roblox.Web.Responses.Avatar.ScaleModel"
    },
    "universeAvatarMaxScales": {
      "$ref": "#/components/schemas/Roblox.Web.Responses.Avatar.ScaleModel"
    },
    "studioAccessToApisAllowed": {
      "description": "Whether Studio can access data stores of this universe.",
      "type": "boolean"
    },
    "permissions": {
      "$ref": "#/components/schemas/Roblox.UniversePluginPermissionAuthority.Models.UniversePluginPermissions"
    },
    "optInRegions": {
      "description": "A list of opt in region.",
      "type": "array",
      "items": {
        "format": "int32",
        "description": "Universe opt in regions ['Unknown' = 0, 'China' = 1]",
        "enum": [
          0,
          1
        ],
        "type": "integer"
      }
    },
    "optOutRegions": {
      "description": "A list of opt out region.",
      "type": "array",
      "items": {
        "format": "int32",
        "description": "Universe opt in regions ['Unknown' = 0, 'China' = 1]",
        "enum": [
          0,
          1
        ],
        "type": "integer"
      }
    },
    "isMeshTextureApiAccessAllowed": {
      "description": "Sets whether access to APIs for mesh and texture is enabled for this universe.",
      "type": "boolean"
    },
    "isRewardedOnDemandAdsAllowed": {
      "description": "Whether rewarded on-demand ads are allowed for this universe.",
      "type": "boolean"
    },
    "fiatBasePriceId": {
      "description": "Sets the base price of the experience for Fiat purchases.",
      "type": "string"
    },
    "fiatProductChangeType": {
      "format": "int32",
      "description": "Determines the change type of the Fiat Product Change request.\r\nCan either Activate, Update Base Price, or Deactivate.",
      "enum": [
        0,
        1,
        2,
        3
      ],
      "type": "integer"
    },
    "audiences": {
      "description": "The audiences this universe should be visible to (e.g. Editors, PlayTesters, Friends, Public).\r\nWhen provided, replaces the universe's existing audience set with the supplied values.",
      "type": "array",
      "items": {
        "format": "int32",
        "description": " ['Invalid' = 0, 'Editors' = 1, 'PlayTesters' = 2, 'Friends' = 3, 'Public' = 4]",
        "enum": [
          0,
          1,
          2,
          3,
          4
        ],
        "type": "integer"
      }
    },
    "demoModeEnabled": {
      "description": "Whether demo mode is enabled for this paid access game.",
      "type": "boolean"
    }
  },
  "additionalProperties": false
}