---
title: "Update a custom field definition"
method: PATCH
path: "/v1/custom_field_definitions/{custom_field_definition_uuid}"
tags: ["Custom Field Definitions"]
---

# Update a custom field definition

`PATCH /v1/custom_field_definitions/{custom_field_definition_uuid}`

## Request

- Base URL: `https://api.capacity.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.capacity.com/v1/custom_field_definitions/{custom_field_definition_uuid}`
- Auth: one of:
  - API key in header `x-capacity-id`
  - HTTP bearer

Update a custom field definition.

## Path parameters

- `custom_field_definition_uuid` string, required

## Request body

- object
  - `choices` object[]: List of key value pairs of custom field definition choices
    - `label` string
    - `value` string

## Response `200`

The updated custom field definition

- object
  - `body` object: Json body data in the request
  - `parameters` object: Query parameters in the request
  - `result` CustomFieldDefinitionSchema
    - `name` string: Name of the custom field definition
    - `choices` object[]: List of choices for the custom field definition
      - `label` string
      - `value` string
    - `custom_field_type_id` integer: ID of the custom field type
    - `custom_field_definition_type_id` integer: ID of the custom field definition type
    - `parent_id` integer, nullable: ID of the parent custom field definition
    - `is_enabled` boolean: Whether the custom field definition is enabled
    - `resource_types` object[]: List of resource types
      - `id` string
      - `name` string
    - `json_schema` object: JSON schema for the custom field definition
    - `placeholder` string: Placeholder text for the custom field definition
    - `future_only` boolean: Indicates if the custom field definition is only for future use
    - `is_sensitive` boolean: Indicates if the custom field definition is sensitive
    - `is_value_dependency_enabled` boolean: Whether value dependency is enabled
    - `custom_field_name` string: Formatted name of the custom field
    - `custom_field_uuid` string: Formatted UUID of the custom field
    - `custom_field_values` string[]: List of possible values for the custom field
    - `custom_field_type` string: Display name of the custom field type
    - `is_dependent` boolean: Whether this field depends on another custom field
    - `parent_custom_field` object, nullable: Information about the parent custom field
      - `id` string
      - `name` string
      - `uuid` string
    - `resources` object[]: Grouped resource types
      - `name` string
      - `resource_parent_id` integer
      - `resource_child_ids` integer[]
      - `is_required` boolean

## Other responses

- `400`: The request contains malformed data or violates data integrity

---

[API](https://skmtc.dev/capacity/apis/capacity-api-docs.md) - [All operations](https://skmtc.dev/capacity/apis/capacity-api-docs/llms.txt) - [OpenAPI document](https://skmtc.dev/capacity/apis/capacity-api-docs/revisions/74c85bb61004?raw)