---
title: "Update a custom profile field by name"
method: PUT
path: "/api/custom-profile-fields/{name}"
tags: ["Custom profile fields"]
---

# Update a custom profile field by name

`PUT /api/custom-profile-fields/{name}`

Update a custom profile field by name.

## Path parameters

- `name` string, required

## Request body

- union
  - object
    - `type` string, "Text", required
    - `label` string
    - `description` string
    - `required` boolean, required
    - `config` object
      - `placeholder` string
      - `minLength` number
      - `maxLength` number
  - object
    - `type` string, "Number", required
    - `label` string
    - `description` string
    - `required` boolean, required
    - `config` object
      - `placeholder` string
      - `minValue` number
      - `maxValue` number
  - object
    - `type` string, "Date", required
    - `label` string
    - `description` string
    - `required` boolean, required
    - `config` object
      - `placeholder` string
      - `format` string, required
      - `customFormat` string
  - object
    - `type` string, "Checkbox", required
    - `label` string
    - `required` boolean, required
    - `config` object
      - `defaultValue` union, required
        - string, "true"
        - string, "false"
  - object
    - `type` string, "Select", required
    - `label` string
    - `description` string
    - `required` boolean, required
    - `config` object, required
      - `placeholder` string
      - `options` object[], required
        - `label` string
        - `value` string, required
  - object
    - `type` string, "Url", required
    - `label` string
    - `description` string
    - `required` boolean, required
    - `config` object
      - `placeholder` string
  - object
    - `type` string, "Regex", required
    - `label` string
    - `description` string
    - `required` boolean, required
    - `config` object, required
      - `placeholder` string
      - `format` string, required
  - object
    - `type` string, "Address", required
    - `label` string
    - `description` string
    - `required` boolean, required
    - `config` object, required
      - `parts` object[], required
        - `enabled` boolean, required
        - `type` 'Text' | 'Number' | 'Date' | 'Checkbox' | 'Select' | 'Url' | 'Regex' | 'Address' | 'Fullname', required
        - `label` string
        - `description` string
        - `required` boolean, required
        - `config` object
          - `placeholder` string
          - `minLength` number
          - `maxLength` number
          - `minValue` number
          - `maxValue` number
          - `format` string
          - `customFormat` string
          - `options` object[]
            - `label` string
            - `value` string, required
          - `defaultValue` string
        - `name` 'formatted' | 'streetAddress' | 'locality' | 'region' | 'postalCode' | 'country', required
  - object
    - `type` string, "Fullname", required
    - `label` string
    - `description` string
    - `required` boolean, required
    - `config` object, required
      - `parts` object[], required
        - `enabled` boolean, required
        - `type` 'Text' | 'Number' | 'Date' | 'Checkbox' | 'Select' | 'Url' | 'Regex' | 'Address' | 'Fullname', required
        - `label` string
        - `description` string
        - `required` boolean, required
        - `config` object
          - `placeholder` string
          - `minLength` number
          - `maxLength` number
          - `minValue` number
          - `maxValue` number
          - `format` string
          - `customFormat` string
          - `options` object[]
            - `label` string
            - `value` string, required
          - `defaultValue` string
        - `name` 'givenName' | 'middleName' | 'familyName', required

## Response `200`

Custom profile field updated successfully.

- object
  - `tenantId` string, required
  - `id` string, required
  - `name` string, required
  - `type` 'Text' | 'Number' | 'Date' | 'Checkbox' | 'Select' | 'Url' | 'Regex' | 'Address' | 'Fullname', required
  - `label` string, required
  - `description` string, nullable, required
  - `required` boolean, required
  - `config` object, required
    - `placeholder` string
    - `minLength` number
    - `maxLength` number
    - `minValue` number
    - `maxValue` number
    - `format` string
    - `customFormat` string
    - `options` object[]
      - `label` string
      - `value` string, required
    - `defaultValue` string
    - `parts` object[]
      - `enabled` boolean, required
      - `name` string, required
      - `type` 'Text' | 'Number' | 'Date' | 'Checkbox' | 'Select' | 'Url' | 'Regex' | 'Address' | 'Fullname', required
      - `label` string
      - `description` string
      - `required` boolean, required
      - `config` object
        - `placeholder` string
        - `minLength` number
        - `maxLength` number
        - `minValue` number
        - `maxValue` number
        - `format` string
        - `customFormat` string
        - `options` object[]
          - `label` string
          - `value` string, required
        - `defaultValue` string
  - `createdAt` number, required
  - `sieOrder` number, required

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found

---

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