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.

POST /v1/avatar/set-scales — openapi

Sets the authenticated user's scales.

Endpoint

Method: POST

Path: /v1/avatar/set-scales

Servers:

Parameters

NameLocationRequiredDescription
Roblox-Place-Idheaderfalse
[
  {
    "in": "header",
    "name": "Roblox-Place-Id",
    "description": "",
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  }
]

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Roblox.Web.Responses.Avatar.ScaleModel"
      }
    },
    "text/json": {
      "schema": {
        "$ref": "#/components/schemas/Roblox.Web.Responses.Avatar.ScaleModel"
      }
    }
  },
  "required": true
}

Responses

StatusDescription
200OK
4001: Please pass in the scales JSON
4010: Authorization has been denied for this request.
4030: Token Validation Failed 3: The user does not have permissions to change scales.
{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Api.Avatar.Models.AvatarApiSuccessResponse"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Api.Avatar.Models.AvatarApiSuccessResponse"
        }
      }
    }
  },
  "400": {
    "description": "1: Please pass in the scales JSON"
  },
  "401": {
    "description": "0: Authorization has been denied for this request."
  },
  "403": {
    "description": "0: Token Validation Failed\r\n3: The user does not have permissions to change scales."
  }
}

Authentication

{
  "security": [
    {
      "roblox-legacy-cookie": []
    }
  ],
  "securitySchemes": {
    "roblox-api-key": {
      "type": "apiKey",
      "description": "A configurable key that allows granular access to Roblox resources. See https://create.roblox.com/docs/cloud/auth/api-keys for more information.",
      "name": "x-api-key",
      "in": "header"
    },
    "roblox-legacy-cookie": {
      "type": "apiKey",
      "description": "A browser cookie that represents the identity of a Roblox user. DO NOT SHARE THIS. Sharing this will allow someone to log in as you and to steal your Robux and items. We do not recommend using cookies to call endpoints. When possible, use API keys with the x-api-key header or OAuth 2.0 instead for authentication.",
      "in": "cookie",
      "name": ".ROBLOSECURITY"
    },
    "roblox-oauth2": {
      "type": "oauth2",
      "description": "Build or authorize apps to access Roblox resources. See https://create.roblox.com/docs/cloud/auth/oauth2-overview for more information.",
      "flows": {
        "authorizationCode": {
          "authorizationUrl": "https://apis.roblox.com/oauth/v1/authorize",
          "tokenUrl": "https://apis.roblox.com/oauth/v1/token",
          "refreshUrl": "https://apis.roblox.com/oauth/v1/token",
          "scopes": {}
        }
      }
    }
  }
}

Complete Operation Definition

{
  "tags": [
    "Avatars"
  ],
  "summary": "Sets the authenticated user's scales.",
  "parameters": [
    {
      "in": "header",
      "name": "Roblox-Place-Id",
      "description": "",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Web.Responses.Avatar.ScaleModel"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Web.Responses.Avatar.ScaleModel"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Api.Avatar.Models.AvatarApiSuccessResponse"
          }
        },
        "text/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Api.Avatar.Models.AvatarApiSuccessResponse"
          }
        }
      }
    },
    "400": {
      "description": "1: Please pass in the scales JSON"
    },
    "401": {
      "description": "0: Authorization has been denied for this request."
    },
    "403": {
      "description": "0: Token Validation Failed\r\n3: The user does not have permissions to change scales."
    }
  },
  "servers": [
    {
      "url": "https://avatar.roblox.com"
    }
  ],
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "security": [
    {
      "roblox-legacy-cookie": []
    }
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/avatars#avatar_post_v1_avatar_set_scales"
  }
}