---
title: "Update a custom field"
method: PATCH
path: "/custom-fields/{id}"
tags: ["custom-fields"]
---

# Update a custom field

`PATCH /custom-fields/{id}`

Updates a custom field definition. Only provided fields are modified.

**Rate limit:** 20 requests per minute

## Path parameters

- `id` string, required

## Request body

- UpdateCustomFieldRequestBody
  - `default_value` string — The default value for single-valued custom fields.
  - `default_values` string[] — The default values for multi-valued custom fields.
  - `description` string — The description of the custom field.
  - `label` string — The label of the custom field.
  - `select_options` CustomFieldDefinitionSelectOption[] — The list options of the select custom field. This is only present for select and multiselect custom fields.
    - `ai_description` string — The AI description of the option. This is used to help the AI understand when to select this option.
    - `label` string — The label of the option.
    - `slug` string — The slug of the option.
  - `slug` string — The slug of the custom field.

## Response `200`

- UpdateCustomFieldResponseBody
  - `data` CustomFieldDefinition
    - `created_at` string — When the custom field was created.
    - `default_value` string — The default value for single-valued custom fields.
    - `default_values` string[] — The default values for multi-valued custom fields.
    - `description` string — The description of the custom field.
    - `id` string — The ID of the custom field.
    - `is_read_only` boolean — Whether the custom field is read only. Fields synced from apps and integrations are read-only.
    - `label` string — The label of the custom field.
    - `number_metadata` NumberMetadata
      - `currency` string — The currency of the number custom field.
      - `decimal_places` integer — The decimal places of the number custom field.
      - `duration_display_format` string — The display format for duration format (auto, minutes, hours, days, months, years).
      - `duration_input_unit` string — The input unit for duration format (seconds, minutes, hours, days).
      - `format` 'with_commas' | 'percent' | 'currency' | 'duration' — The format of the number custom field.
    - `object_type` string — The type of object this custom field is for. Can be "account", "issue", or "contact".
    - `select_metadata` SelectMetadata
      - `options` CustomFieldDefinitionSelectOption[] — The list options of the select custom field. This is only present for select and multiselect custom fields.
        - `ai_description` string — The AI description of the option. This is used to help the AI understand when to select this option.
        - `label` string — The label of the option.
        - `slug` string — The slug of the option.
    - `slug` string — The slug of the custom field.
    - `source` string — The source of the custom field.
    - `type` string — The type of the custom field.
    - `updated_at` string — When the custom field was last updated.
  - `request_id` string — The request ID for tracking.

## Other responses

- `400` — The request was invalid or could not be completed.
- `404`
- `500` — An unexpected internal error occurred.

---

[API](https://skmtc.net/usepylon/apis/pylon-api.md) · [All operations](https://skmtc.net/usepylon/apis/pylon-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/usepylon/pylon-api/versions/999c51740b4e/schema)