---
title: "Update a custom field key"
method: PUT
path: "/custom_field_keys/{custom_field_key_id}"
tags: ["custom_fields"]
---

# Update a custom field key

`PUT /custom_field_keys/{custom_field_key_id}`

Update the matching custom field key.

> **Warning:** It is NOT recommended to update keys that are currently in
use. Changing allowed values or whether they are restricted after other
values have already been used can lead to undesirable results.

## Headers

- `Accept` 'application/json', required

## Request body

- object
  - `data` object, required
    - `attributes` object, required
      - `name` string — The key name.
      - `allowed_values` string[] — The `value` that can be used with this `key` when creating or updating any Custom Field on an Asset must be one of these strings. If not included or empty array `[]`, the `values` are unrestricted.

## Response `200`

The updated custom field key.

- object
  - `data` object, required
    - `id` string, required — Unique identifier for the resource instance.
    - `type` 'custom_field_keys', required — The type of the resource.
    - `attributes` object, required
      - `name` string — The key name.
      - `allowed_values` string[] — The `value` that can be used with this `key` when creating or updating any Custom Field on an Asset must be one of these strings. If not included or empty array `[]`, the `values` are unrestricted.
      - `position` integer — Sets the location of the custom field among other custom fields in the Brandfolder UI.
      - `prioritized` boolean — Set to `true` to display the custom field in asset previews. A Brandfolder can have up to five prioritized custom fields.
      - `required` boolean — If set to `true`, users uploading an asset must input the custom field before uploading the asset. Children of dependent custom fields can also be marked as required.
      - `restricted` boolean — If set to `true`, the field value is restricted to a set of allowed values (see `allowed_values`); otherwise, the field value is unrestricted.

## Other responses

- `default` — Generic error payload

---

[API](https://skmtc.dev/smartsheet/apis/brandfolder-openapi-reference.md) · [All operations](https://skmtc.dev/smartsheet/apis/brandfolder-openapi-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/smartsheet/brandfolder-openapi-reference/revisions/fd95b0a2d2f8/schema)