---
title: "Sets the avatar to the incoming avatar using field masks."
method: PATCH
path: "/v2/avatar"
tags: ["Avatars"]
deprecated: true
---

# Sets the avatar to the incoming avatar using field masks.

`PATCH /v2/avatar`

> **Deprecated.**

Only allows items that you own, are not expired, and are wearable asset types.
Any assets being worn before this method is called are automatically removed.

Please use PATCH v4/avatar

## Headers

- `Roblox-Place-Id` integer

## Request body

- RobloxApiAvatarModelsUpdateAvatarRequestModel — A model containing details about an avatar update request.
  - `updateMask` integer[] — Update mask specifying which avatar fields to update (can include multiple). Acceptable values: - UpdateAvatarType: updates avatar.type (R6/R15) - UpdateScales: updates avatar.scale - UpdateBodyColors: updates avatar.body_color_set - UpdateAssets: updates avatar.avatar_assets
  - `data` RobloxApiAvatarModelsUpdateAvatarDataModel — A model containing details about an avatar.
    - `scales` RobloxWebResponsesAvatarScaleModel
      - `height` number, double
      - `width` number, double
      - `head` number, double
      - `depth` number, double
      - `proportion` number, double
      - `bodyType` number, double
    - `playerAvatarType` 1 | 3 — The avatar type.
    - `bodyColors` RobloxApiAvatarModelsBodyColors3Model — A model containing RGB hex colors for each body part.
      - `headColor3` string — The RGB hex color for head color, e.g. #FFFFFF
      - `torsoColor3` string — The RGB hex color for torso color, e.g. #FFFFFF
      - `rightArmColor3` string — The RGB hex color for right arm color, e.g. #FFFFFF
      - `leftArmColor3` string — The RGB hex color for left arm color, e.g. #FFFFFF
      - `rightLegColor3` string — The RGB hex color for right leg color, e.g. #FFFFFF
      - `leftLegColor3` string — The RGB hex color for left leg color, e.g. #FFFFFF
    - `assets` RobloxApiAvatarModelsAssetWearModel[] — The assets worn on the character.
      - `id` integer — An asset id
      - `meta` RobloxApiAvatarModelsAssetMetaModelV1 — Exhaustive model denoting all possible metadata fields of an asset
        - `order` integer — Layered-clothing order
        - `puffiness` number, float — Layered-clothing puffiness
        - `position` RobloxApiAvatarModelsAssetPosition — A model which contains accessory position coordinates.
          - `X` number, float — X coordinate of the position.
          - `Y` number, float — y coordinate of the position.
          - `Z` number, float — Z coordinate of the position.
        - `rotation` RobloxApiAvatarModelsAssetRotation — A model which contains accessory rotation coordinates.
          - `X` number, float — X degrees of the rotation.
          - `Y` number, float — Y degrees of the rotation.
          - `Z` number, float — Z degrees of the rotation.
        - `scale` RobloxApiAvatarModelsAssetScale — A model which contains accessory scale.
          - `X` number, float — X scale multiplier of accessory.
          - `Y` number, float — Y scale multiplier of accessory.
          - `Z` number, float — Z scale multiplier of accessory.
        - `headShape` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 — Head Shape selected for the asset id. Applicable for dynamic head assets.
        - `staticFacialAnimation` boolean — Indicates user choice for facial animation. staticFacialAnimation=false, implies the toggle as on and face will animate. Applicable for dynamic head assets.
        - `version` integer — Client-authoritative meta model format version - default is always 1

## Response `200`

OK

- RobloxApiAvatarModelsUpdateAvatarResponseModel — A model for update avatar responses.
  - `invalidAssets` RobloxApiAvatarModelsAssetModelV2[] — The assets that could not be worn Unlike invalidAssetIds, only contains assets that are wearable types.
    - `id` integer — The id
    - `name` string — The name
    - `assetType` RobloxApiAvatarModelsAssetTypeModel — A model containing details about an asset type
      - `id` integer — The id
      - `name` string — The name
    - `currentVersionId` integer — Id of the current version of asset
    - `meta` RobloxApiAvatarModelsAssetMetaModelV1 — Exhaustive model denoting all possible metadata fields of an asset
      - `order` integer — Layered-clothing order
      - `puffiness` number, float — Layered-clothing puffiness
      - `position` RobloxApiAvatarModelsAssetPosition — A model which contains accessory position coordinates.
        - `X` number, float — X coordinate of the position.
        - `Y` number, float — y coordinate of the position.
        - `Z` number, float — Z coordinate of the position.
      - `rotation` RobloxApiAvatarModelsAssetRotation — A model which contains accessory rotation coordinates.
        - `X` number, float — X degrees of the rotation.
        - `Y` number, float — Y degrees of the rotation.
        - `Z` number, float — Z degrees of the rotation.
      - `scale` RobloxApiAvatarModelsAssetScale — A model which contains accessory scale.
        - `X` number, float — X scale multiplier of accessory.
        - `Y` number, float — Y scale multiplier of accessory.
        - `Z` number, float — Z scale multiplier of accessory.
      - `headShape` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 — Head Shape selected for the asset id. Applicable for dynamic head assets.
      - `staticFacialAnimation` boolean — Indicates user choice for facial animation. staticFacialAnimation=false, implies the toggle as on and face will animate. Applicable for dynamic head assets.
      - `version` integer — Client-authoritative meta model format version - default is always 1
    - `availabilityStatus` string — Asset availability status.
    - `expirationTime` string, date-time — For rental assets only. (Future) ownership expiration time of the asset.
    - `supportsHeadShapes` boolean — If the "Id" is swappable, applicable for DH assets.
  - `success` boolean — Whether or not all the outfit contents were successfully worn.

## Other responses

- `400` — 3: Invalid assetId 5: Meta does not apply to specified asset type 7: Required meta is not provided for the specific asset type
- `401` — 0: Authorization has been denied for this request.
- `403` — 0: Token Validation Failed
- `500` — 2: Failed to wear asset.

---

[API](https://skmtc.net/roblox/apis/roblox-api.md) · [All operations](https://skmtc.net/roblox/apis/roblox-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/roblox/roblox-api/revisions/1d2042bb1a48/schema)