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

A model containing details about avatar-related business rules

Properties

NameTypeRequiredDescription
playerAvatarTypesarrayfalseThe avatar type
scalesobjectfalseThe scales
wearableAssetTypesarrayfalseThe assets worn on the character
accessoryRefinementTypesarrayfalseThe list of asset type ids for Accessory Refinement.
accessoryRefinementLowerBoundsobjectfalseThe lower bounds for accessory refinement settings.
accessoryRefinementUpperBoundsobjectfalseThe lower bounds for accessory refinement settings.
bodyColorsPalettearrayfalseThe full set of usable body colors
basicBodyColorsPalettearrayfalseThe basic set of body colors
minimumDeltaEBodyColorDifferencenumberfalseThe minimum Delta-E difference in body colors for default clothing not to be applied
proportionsAndBodyTypeEnabledForUserbooleanfalseWhether proportion and bodyType scales are allowed to be set by the authenticated user
defaultClothingAssetLists#/components/schemas/Roblox.Api.Avatar.Models.DefaultClothingAssetsfalse
bundlesEnabledForUserbooleanfalseWhether or not bundles are enabled for the specific user
emotesEnabledForUserbooleanfalseWhether or not emotes are enabled

Complete Schema

{
  "description": "A model containing details about avatar-related business rules",
  "type": "object",
  "properties": {
    "playerAvatarTypes": {
      "description": "The avatar type",
      "type": "array",
      "items": {
        "format": "int32",
        "description": "https://confluence.roblox.com/display/PLATFORM/Avatar+Project+2016\r\nWhat avatar type does the player prefer to have?",
        "enum": [
          1,
          3
        ],
        "type": "integer"
      }
    },
    "scales": {
      "description": "The scales",
      "type": "object",
      "additionalProperties": {
        "$ref": "#/components/schemas/Roblox.Api.Avatar.Models.ScaleRulesModel"
      }
    },
    "wearableAssetTypes": {
      "description": "The assets worn on the character",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Roblox.Api.Avatar.Models.AssetTypeRulesModel"
      }
    },
    "accessoryRefinementTypes": {
      "description": "The list of asset type ids for Accessory Refinement.",
      "type": "array",
      "items": {
        "format": "int32",
        "type": "integer"
      }
    },
    "accessoryRefinementLowerBounds": {
      "description": "The lower bounds for accessory refinement settings.",
      "type": "object",
      "additionalProperties": {
        "$ref": "#/components/schemas/Roblox.Api.Avatar.Models.AccessoryRefinementModel"
      }
    },
    "accessoryRefinementUpperBounds": {
      "description": "The lower bounds for accessory refinement settings.",
      "type": "object",
      "additionalProperties": {
        "$ref": "#/components/schemas/Roblox.Api.Avatar.Models.AccessoryRefinementModel"
      }
    },
    "bodyColorsPalette": {
      "description": "The full set of usable body colors",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Roblox.Api.Avatar.Models.BodyColorModel"
      }
    },
    "basicBodyColorsPalette": {
      "description": "The basic set of body colors",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Roblox.Api.Avatar.Models.BodyColorModel"
      }
    },
    "minimumDeltaEBodyColorDifference": {
      "format": "double",
      "description": "The minimum Delta-E difference in body colors\r\nfor default clothing not to be applied",
      "type": "number"
    },
    "proportionsAndBodyTypeEnabledForUser": {
      "description": "Whether proportion and bodyType scales are allowed to be set by the authenticated user",
      "type": "boolean"
    },
    "defaultClothingAssetLists": {
      "$ref": "#/components/schemas/Roblox.Api.Avatar.Models.DefaultClothingAssets"
    },
    "bundlesEnabledForUser": {
      "description": "Whether or not bundles are enabled for the specific user",
      "type": "boolean"
    },
    "emotesEnabledForUser": {
      "description": "Whether or not emotes are enabled",
      "type": "boolean"
    }
  },
  "additionalProperties": false
}