PATCH /v2/outfits/{userOutfitId} — openapi

Updates the contents of an outfit.

Fails if the user does not own any of the assetIds or if they are not wearable asset types. Accepts partial updates.

Please use PATCH v4/outfits/{outfitId}

Endpoint

Method: PATCH

Path: /v2/outfits/{userOutfitId}

Servers:

https://avatar.roblox.com

Parameters

Name	Location	Required	Description
userOutfitId	path	true	The user outfit id.
Roblox-Place-Id	header	false

[
  {
    "in": "path",
    "name": "userOutfitId",
    "description": "The user outfit id.",
    "required": true,
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  },
  {
    "in": "header",
    "name": "Roblox-Place-Id",
    "description": "",
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  }
]

Request Body

The updated outfit.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Roblox.Api.Avatar.Models.OutfitUpdateModelV2"
      }
    },
    "text/json": {
      "schema": {
        "$ref": "#/components/schemas/Roblox.Api.Avatar.Models.OutfitUpdateModelV2"
      }
    }
  },
  "description": "The updated outfit.",
  "required": true
}

Responses

Status	Description
200	OK
400	3: Body colors must be valid BrickColor IDs 4: Invalid outfit name 5: Asset is not wearable by you 8: Invalid Player Avatar Type. Valid types are R6 and R15 11: Meta does not apply to specified asset type 12: Meta is required for this specific asset type 13: Invalid Outfit Type 14: Invalid scale
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 2: You don't have permission to update this outfit.
404	1: The specified userOutfit does not exist!
500	6: An error occurred while trying to update the outfit

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Api.Avatar.Models.OutfitModel"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Api.Avatar.Models.OutfitModel"
        }
      }
    }
  },
  "400": {
    "description": "3: Body colors must be valid BrickColor IDs\r\n4: Invalid outfit name\r\n5: Asset is not wearable by you\r\n8: Invalid Player Avatar Type. Valid types are R6 and R15\r\n11: Meta does not apply to specified asset type\r\n12: Meta is required for this specific asset type\r\n13: Invalid Outfit Type\r\n14: Invalid scale"
  },
  "401": {
    "description": "0: Authorization has been denied for this request."
  },
  "403": {
    "description": "0: Token Validation Failed\r\n2: You don't have permission to update this outfit."
  },
  "404": {
    "description": "1: The specified userOutfit does not exist!"
  },
  "500": {
    "description": "6: An error occurred while trying to update the outfit"
  }
}

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": "Updates the contents of an outfit.",
  "description": "Fails if the user does not own any of the assetIds or if they are not wearable asset types.\r\nAccepts partial updates.\n\nPlease use PATCH v4/outfits/{outfitId}",
  "parameters": [
    {
      "in": "path",
      "name": "userOutfitId",
      "description": "The user outfit id.",
      "required": true,
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "in": "header",
      "name": "Roblox-Place-Id",
      "description": "",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Api.Avatar.Models.OutfitUpdateModelV2"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Api.Avatar.Models.OutfitUpdateModelV2"
        }
      }
    },
    "description": "The updated outfit.",
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Api.Avatar.Models.OutfitModel"
          }
        },
        "text/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Api.Avatar.Models.OutfitModel"
          }
        }
      }
    },
    "400": {
      "description": "3: Body colors must be valid BrickColor IDs\r\n4: Invalid outfit name\r\n5: Asset is not wearable by you\r\n8: Invalid Player Avatar Type. Valid types are R6 and R15\r\n11: Meta does not apply to specified asset type\r\n12: Meta is required for this specific asset type\r\n13: Invalid Outfit Type\r\n14: Invalid scale"
    },
    "401": {
      "description": "0: Authorization has been denied for this request."
    },
    "403": {
      "description": "0: Token Validation Failed\r\n2: You don't have permission to update this outfit."
    },
    "404": {
      "description": "1: The specified userOutfit does not exist!"
    },
    "500": {
      "description": "6: An error occurred while trying to update the outfit"
    }
  },
  "deprecated": true,
  "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_patch_v2_outfits__userOutfitId_"
  },
  "x-roblox-recommended-alternatives": [
    {
      "url": "https://avatar.roblox.com/v3/outfits/{userOutfitId}",
      "httpMethod": "PATCH",
      "documentationUrl": "https://create.roblox.com/docs/cloud/reference/features/avatars#avatar_patch_v3_outfits__userOutfitId_"
    }
  ]
}