Update Head

Update Head

Path Parameters

head_id uuid required

application/json

Request Body required

name Name
output_format object
style object
version object
head_metadata object
hair_id Hair Id
hair_color object

Responses

• 200
• 422

---

Successful Response

application/json

Schema

Example (from schema)

---

Schema

name Name required
output_format object
style object
version object
id uuid required
url uri required

Possible values: non-empty

created_at date-time required
updated_at date-time required
hair object
name Name required
Possible values: <= 100 characters
source_type SourceTypes
Possible values: [custom, default, exclusive, payable, promotion, designed, external, assembled, generated]
Default value: custom
obj_metadata object required
style AssetStyles
Possible values: [phr, vox, sca, crt]
Default value: phr
gender Gender required
Possible values: [male, female]
id uuid required
url uri required
Possible values: non-empty
thumbnail_url Thumbnail Url
payable_data object
price Price required
description Description
created_at date-time required
updated_at Updated At
lod object
ar_url Ar Url

{
  "name": "string",
  "output_format": "glb",
  "style": "phr",
  "version": "v1",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "url": "string",
  "created_at": "2025-04-10T16:37:32.311Z",
  "updated_at": "2025-04-10T16:37:32.311Z",
  "hair": {
    "name": "string",
    "source_type": "custom",
    "obj_metadata": {},
    "style": "phr",
    "gender": "male",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "url": "string",
    "thumbnail_url": "string",
    "payable_data": {
      "price": 0,
      "description": "string"
    },
    "created_at": "2025-04-10T16:37:32.312Z",
    "updated_at": "string"
  },
  "lod": {},
  "ar_url": "string"
}

Validation Error

application/json

Schema

Example (from schema)

---

Schema

detail object[]
Array [
loc object[] required
Array [
anyOf
MOD1
MOD2
---
string
integer
]
msg Message required
type Error Type required
]

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

PATCH /heads/:head_id

Authorization

name: OAuth2PasswordBearertype: oauth2flows: {
  "password": {
    "scopes": {},
    "tokenUrl": "login"
  }
}

Request

Base URL

https://api.unionavatars.com/v2

Security Scheme

OAuth2PasswordBearerAPIKeyHeader

Bearer Token

head_id — path required

Body required

{
  "name": "string",
  "output_format": "glb",
  "style": "phr",
  "version": "v1",
  "head_metadata": {},
  "hair_id": "string",
  "hair_color": {}
}

curl -L -X PATCH 'https://api.unionavatars.com/v2/heads/:head_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "string",
  "output_format": "glb",
  "style": "phr",
  "version": "v1",
  "head_metadata": {},
  "hair_id": "string",
  "hair_color": {}
}'

curl -L -X PATCH 'https://api.unionavatars.com/v2/heads/:head_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "string",
  "output_format": "glb",
  "style": "phr",
  "version": "v1",
  "head_metadata": {},
  "hair_id": "string",
  "hair_color": {}
}'

curl -L -X PATCH 'https://api.unionavatars.com/v2/heads/:head_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "string",
  "output_format": "glb",
  "style": "phr",
  "version": "v1",
  "head_metadata": {},
  "hair_id": "string",
  "hair_color": {}
}'

curl -L -X PATCH 'https://api.unionavatars.com/v2/heads/:head_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "string",
  "output_format": "glb",
  "style": "phr",
  "version": "v1",
  "head_metadata": {},
  "hair_id": "string",
  "hair_color": {}
}'

curl -L -X PATCH 'https://api.unionavatars.com/v2/heads/:head_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "string",
  "output_format": "glb",
  "style": "phr",
  "version": "v1",
  "head_metadata": {},
  "hair_id": "string",
  "hair_color": {}
}'

curl -L -X PATCH 'https://api.unionavatars.com/v2/heads/:head_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "string",
  "output_format": "glb",
  "style": "phr",
  "version": "v1",
  "head_metadata": {},
  "hair_id": "string",
  "hair_color": {}
}'

curl -L -X PATCH 'https://api.unionavatars.com/v2/heads/:head_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "string",
  "output_format": "glb",
  "style": "phr",
  "version": "v1",
  "head_metadata": {},
  "hair_id": "string",
  "hair_color": {}
}'

curl -L -X PATCH 'https://api.unionavatars.com/v2/heads/:head_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "string",
  "output_format": "glb",
  "style": "phr",
  "version": "v1",
  "head_metadata": {},
  "hair_id": "string",
  "hair_color": {}
}'

curl -L -X PATCH 'https://api.unionavatars.com/v2/heads/:head_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "string",
  "output_format": "glb",
  "style": "phr",
  "version": "v1",
  "head_metadata": {},
  "hair_id": "string",
  "hair_color": {}
}'