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

Model for UniverseSettings controller responses

Properties

NameTypeRequiredDescription
allowPrivateServersbooleanfalseIf the universe allows the use of private servers.
privateServerPriceintegerfalseThe price to purchase a private server in robux.
isMeshTextureApiAccessAllowedbooleanfalseWhether access to APIs for mesh and texture is enabled for this universe.
isRewardedOnDemandAdsAllowedbooleanfalseWhether rewarded on-demand ads are allowed for this universe.
idintegerfalseThe universe Id.
namestringfalseThe universe name.
promotionalTextstringfalsePromotional Text for the universe.
universeAvatarTypeintegerfalseWhich avatar types are allowed in the universe. ['MorphToR6' = 1, 'PlayerChoice' = 2, 'MorphToR15' = 3]
universeScaleTypeintegerfalseWhether custom scales allowed in the universe. ['NoScales' = 1, 'AllScales' = 2]
universeAnimationTypeintegerfalseWhether custom animations are allowed in the universe. ['Standard' = 1, 'PlayerChoice' = 2]
universeCollisionTypeintegerfalseWhat type of collisions are used by the universe. ['InnerBox' = 1, 'OuterBox' = 2]
universeBodyTypeintegerfalseWhat avatar body types are allowed by the universe. ['Standard' = 1, 'PlayerChoice' = 2]
universeJointPositioningTypeintegerfalseWhat avatar joint positioning is allowed by the universe. ['Standard' = 1, 'ArtistIntent' = 2]
isArchivedbooleanfalseArchive status of the universe
isFriendsOnlybooleanfalseWhether game access is limited to friends for user-owned games or group members for group-owned games.
genreintegerfalseGame 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]
playableDevicesarrayfalseList of device types this game can be played on.
isForSalebooleanfalseWhether the game is offered for sale.
priceintegerfalsePrice of the game, in Robux.
isStudioAccessToApisAllowedbooleanfalseWhether studio access to APIs is allowed or not.
privacyTypestringfalsePrivacy type of the universe.
isForSaleInFiatbooleanfalseWhether the game is offered for sale in fiat.
fiatBasePriceIdstringfalseThe basePriceId for the Fiat product.
fiatModerationStatusintegerfalseThe current moderation status of the game if it is for sale in fiat. ['Invalid' = 0, 'NotModerated' = 1, 'Pending' = 2, 'Approved' = 3, 'Rejected' = 4]
audiencesarrayfalseThe 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.
demoModeEnabledbooleanfalseWhether demo mode is enabled.
demoModeChangeableAfterstringfalseThe 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).

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"
    },
    "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"
    },
    "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"
    },
    "universeScaleType": {
      "format": "int32",
      "description": "Whether custom scales allowed in the universe. ['NoScales' = 1, 'AllScales' = 2]",
      "enum": [
        1,
        2
      ],
      "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"
    },
    "universeBodyType": {
      "format": "int32",
      "description": "What avatar body types are allowed by the universe. ['Standard' = 1, 'PlayerChoice' = 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"
    },
    "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"
    },
    "isStudioAccessToApisAllowed": {
      "description": "Whether studio access to APIs is allowed or not.",
      "type": "boolean"
    },
    "privacyType": {
      "description": "Privacy type of the universe.",
      "type": "string"
    },
    "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
}