3 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.Avatar.Models.AvatarMetadataModel — openapi

A model containing website metadata for avatars

Properties

NameTypeRequiredDescription
enableDefaultClothingMessagebooleanfalseWhether or not to show the Default Clothing message
isAvatarScaleEmbeddedInTabbooleanfalseWhether or not the Scales is embedded in the tab
isBodyTypeScaleOutOfTabbooleanfalseWhether or not the Boby Type scale is embedded in the tab
scaleHeightIncrementnumberfalseHow much the height scaler should increment by
scaleWidthIncrementnumberfalseHow much the width scaler should increment by
scaleHeadIncrementnumberfalseHow much the head scaler should increment by
scaleProportionIncrementnumberfalseHow much the proportion scaler should increment by
scaleBodyTypeIncrementnumberfalseHow much the body type scaler should increment by
supportProportionAndBodyTypebooleanfalseWhether or not to support proportion and body type
showDefaultClothingMessageOnPageLoadbooleanfalseWhether or not to show the default clothing message when the page loads
areThreeDeeThumbsEnabledbooleanfalseWhether or not 3D thumbnails are shown
isAvatarWearingApiCallsLockingOnFrontendEnabledbooleanfalseDoes the frontend lock avatar editor input until the wearing call returns
isOutfitHandlingOnFrontendEnabledbooleanfalseDoes the frontend lock avatar editor input until the wearing call returns
isJustinUiChangesEnabledbooleanfalseDetermines whether a bunch of UI improvements are released
isCategoryReorgEnabledbooleanfalseDetermines whether Category Reorg is released
LCEnabledInEditorAndCatalogbooleanfalseFlag for both web UI and App, name is fixed due to sharing, do not change
isLCCompletelyEnabledbooleanfalseUseful for the time between enabling Jackets for most users and all LC types for everyone, meanwhile Soothsayers need all types at all times

Complete Schema

{
  "description": "A model containing website metadata for avatars",
  "type": "object",
  "properties": {
    "enableDefaultClothingMessage": {
      "description": "Whether or not to show the Default Clothing message",
      "type": "boolean"
    },
    "isAvatarScaleEmbeddedInTab": {
      "description": "Whether or not the Scales is embedded in the tab",
      "type": "boolean"
    },
    "isBodyTypeScaleOutOfTab": {
      "description": "Whether or not the Boby Type scale is embedded in the tab",
      "type": "boolean"
    },
    "scaleHeightIncrement": {
      "format": "double",
      "description": "How much the height scaler should increment by",
      "type": "number"
    },
    "scaleWidthIncrement": {
      "format": "double",
      "description": "How much the width scaler should increment by",
      "type": "number"
    },
    "scaleHeadIncrement": {
      "format": "double",
      "description": "How much the head scaler should increment by",
      "type": "number"
    },
    "scaleProportionIncrement": {
      "format": "double",
      "description": "How much the proportion scaler should increment by",
      "type": "number"
    },
    "scaleBodyTypeIncrement": {
      "format": "double",
      "description": "How much the body type scaler should increment by",
      "type": "number"
    },
    "supportProportionAndBodyType": {
      "description": "Whether or not to support proportion and body type",
      "type": "boolean"
    },
    "showDefaultClothingMessageOnPageLoad": {
      "description": "Whether or not to show the default clothing message when the page loads",
      "type": "boolean"
    },
    "areThreeDeeThumbsEnabled": {
      "description": "Whether or not 3D thumbnails are shown",
      "type": "boolean"
    },
    "isAvatarWearingApiCallsLockingOnFrontendEnabled": {
      "description": "Does the frontend lock avatar editor input until the wearing call returns",
      "type": "boolean"
    },
    "isOutfitHandlingOnFrontendEnabled": {
      "description": "Does the frontend lock avatar editor input until the wearing call returns",
      "type": "boolean"
    },
    "isJustinUiChangesEnabled": {
      "description": "Determines whether a bunch of UI improvements are released",
      "type": "boolean"
    },
    "isCategoryReorgEnabled": {
      "description": "Determines whether Category Reorg is released",
      "type": "boolean"
    },
    "LCEnabledInEditorAndCatalog": {
      "description": "Flag for both web UI and App, name is fixed due to sharing, do not change",
      "type": "boolean"
    },
    "isLCCompletelyEnabled": {
      "description": "Useful for the time between enabling Jackets for most users and\r\nall LC types for everyone, meanwhile Soothsayers need all types\r\nat all times",
      "type": "boolean"
    }
  },
  "additionalProperties": false
}