---
title: "Update a user attribute"
method: PUT
path: "/api/v1/user-attributes/{id}"
tags: ["User Attributes"]
---

# Update a user attribute

`PUT /api/v1/user-attributes/{id}`

Required scope - root

## Path parameters

- `id` number, required

## Request body

- PutUserAttributeReq
  - `name` string
  - `locales` object[]
    - `locale` string, required
    - `value` string, required
  - `includeInSignUpForm` boolean
  - `requiredInSignUpForm` boolean
  - `includeInIdTokenBody` boolean
  - `includeInUserInfo` boolean
  - `unique` boolean
  - `validationRegex` string
  - `validationLocales` object[]
    - `locale` string, required
    - `value` string, required

## Response `200`

A user attribute

- object
  - `userAttribute` UserAttribute
    - `id` number, required
    - `name` string, required
    - `locales` object[]
      - `locale` string, required
      - `value` string, required
    - `includeInSignUpForm` boolean, required
    - `requiredInSignUpForm` boolean, required
    - `includeInIdTokenBody` boolean, required
    - `includeInUserInfo` boolean, required
    - `unique` boolean, required
    - `validationRegex` string, required
    - `validationLocales` object[], required
      - `locale` string, required
      - `value` string, required
    - `createdAt` string, required
    - `updatedAt` string, required
    - `deletedAt` string, nullable, required

---

[API](https://skmtc.net/valuemelody/apis/melody-auth-s2s-api.md) · [All operations](https://skmtc.net/valuemelody/apis/melody-auth-s2s-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/valuemelody/melody-auth-s2s-api/revisions/2e1471620fd7/schema)