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.UniverseSettingsResponseV2 — openapi

Model for UniverseSettings controller responses

Properties

Related Schemas

• Roblox.Api.Develop.Models.UniverseModerationPolicyStatus

• Roblox.Platform.UniverseSettings.UniverseAvatarAssetOverrideResponseModel

• Roblox.Web.Responses.Avatar.ScaleModel

• Roblox.UniversePluginPermissionAuthority.Models.UniversePluginPermissions

Complete Schema

{
  "description": "Model for UniverseSettings controller responses",
  "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"
    },
    "optInRegions": {
      "description": "The regions the universe has opted in for",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Roblox.Api.Develop.Models.UniverseModerationPolicyStatus"
      }
    },
    "isMeshTextureApiAccessAllowed": {
      "description": "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"
    },
    "id": {
      "format": "int64",
      "description": "The universe Id.",
      "type": "integer"
    },
    "name": {
      "description": "The universe name.",
      "type": "string"
    },
    "description": {
      "description": "The universe description.",
      "type": "string"
    },
    "promotionalText": {
      "description": "Promotional Text for the universe.",
      "type": "string"
    },
    "universeAvatarType": {
      "format": "int32",
      "description": "Which avatar types are allowed in the universe. ['MorphToR6' = 1, 'PlayerChoice' = 2, 'MorphToR15' = 3]",
      "enum": [
        1,
        2,
        3
      ],
      "type": "integer"
    },
    "universeAnimationType": {
      "format": "int32",
      "description": "Whether custom animations are allowed in the universe. ['Standard' = 1, 'PlayerChoice' = 2]",
      "enum": [
        1,
        2
      ],
      "type": "integer"
    },
    "universeCollisionType": {
      "format": "int32",
      "description": "What type of collisions are used by the universe. ['InnerBox' = 1, 'OuterBox' = 2]",
      "enum": [
        1,
        2
      ],
      "type": "integer"
    },
    "universeJointPositioningType": {
      "format": "int32",
      "description": "What avatar joint positioning is allowed by the universe. ['Standard' = 1, 'ArtistIntent' = 2]",
      "enum": [
        1,
        2
      ],
      "type": "integer"
    },
    "engineAvatarSettings": {
      "description": "Optional JSON string used to store avatar settings used by the game engine.\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. ['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]",
      "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 collection of avatar asset settings allowed by the universe.",
      "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"
    },
    "isForSaleInFiat": {
      "description": "Whether the game is offered for sale in fiat.",
      "type": "boolean"
    },
    "fiatBasePriceId": {
      "description": "The basePriceId for the Fiat product.",
      "type": "string"
    },
    "fiatModerationStatus": {
      "format": "int32",
      "description": "The current moderation status of the game if it is for sale in fiat. ['Invalid' = 0, 'NotModerated' = 1, 'Pending' = 2, 'Approved' = 3, 'Rejected' = 4]",
      "enum": [
        0,
        1,
        2,
        3,
        4
      ],
      "type": "integer"
    },
    "audiences": {
      "description": "The audiences this universe is visible to (e.g. Editors, PlayTesters, Friends, Public).\r\nAlways non-null; may be empty when audience visibility has not been configured.",
      "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.",
      "type": "boolean"
    },
    "demoModeChangeableAfter": {
      "format": "date-time",
      "description": "The earliest time at which demo mode can be toggled again (ISO 8601).\r\nNull when no cooldown is active (i.e. demo mode can be changed immediately).",
      "type": "string"
    }
  },
  "additionalProperties": false
}