4 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.UniverseSettingsRequest — openapi

Model for UniverseSettings patch requests

Properties

NameTypeRequiredDescription
namestringfalseThe name of the universe.
universeAvatarTypeintegerfalseWhich avatar types are allowed in the universe.
universeScaleTypeintegerfalseWhether custom scales allowed in the universe.
universeAnimationTypeintegerfalseWhether custom animations are allowed in the universe.
universeCollisionTypeintegerfalseWhat type of collisions are used by the universe.
universeBodyTypeintegerfalseWhat avatar body types are allowed by the universe.
universeJointPositioningTypeintegerfalseWhat avatar joint positioning type is allowed by the universe.
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.
playableDevicesarrayfalseList of device types this game can be played on.
isForSalebooleanfalseWhether the game is offered for sale.
priceintegerfalsePrice of the game, in Robux.
isMeshTextureApiAccessAllowedbooleanfalseSets whether access to APIs for mesh and texture is enabled for this universe.
isRewardedOnDemandAdsAllowedbooleanfalseSet is rewarded on-demand ads are allowed for this universe.
fiatBasePriceIdstringfalseSets the base price of the experience for Fiat purchases.
fiatProductChangeTypeintegerfalseDetermines the change type of the Fiat Product Change request. Can either Activate the product, Update the price, or Deactivate the product.
demoModeEnabledbooleanfalseWhether demo mode is enabled for this paid access game.

Complete Schema

{
  "description": "Model for UniverseSettings patch requests",
  "type": "object",
  "properties": {
    "name": {
      "description": "The name of the universe.",
      "type": "string"
    },
    "universeAvatarType": {
      "format": "int32",
      "description": "Which avatar types are allowed in the universe.",
      "enum": [
        1,
        2,
        3
      ],
      "type": "integer"
    },
    "universeScaleType": {
      "format": "int32",
      "description": "Whether custom scales allowed in the universe.",
      "enum": [
        1,
        2
      ],
      "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"
    },
    "universeBodyType": {
      "format": "int32",
      "description": "What avatar body types are allowed 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"
    },
    "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"
    },
    "isMeshTextureApiAccessAllowed": {
      "description": "Sets whether access to APIs for mesh and texture is enabled for this universe.",
      "type": "boolean"
    },
    "isRewardedOnDemandAdsAllowed": {
      "description": "Set is 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 the product, Update the price, or Deactivate the product.",
      "enum": [
        0,
        1,
        2,
        3
      ],
      "type": "integer"
    },
    "demoModeEnabled": {
      "description": "Whether demo mode is enabled for this paid access game.",
      "type": "boolean"
    }
  },
  "additionalProperties": false
}