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

# Update a custom field definition

`PATCH /custom_field_definitions/{id}`

## Request body

- object
  - `data` object
    - `type` 'custom_field_definition', required
    - `attributes` object, required
      - `display_name` string
      - `description` string, nullable
      - `validation` object, nullable
      - `default_format` string, nullable
      - `default_value` union — Raw custom field value (type depends on definition)
        - string
        - number
        - boolean
        - string[]
        - object

## Response `200`

OK

- object
  - `data` CustomFieldDefinition
    - `id` string, uuid, required
    - `type` 'custom_field_definition', required
    - `attributes` object
      - `entity_type` 'Shipment' | 'Container' | 'TrackingRequest', required
      - `api_slug` string, required
      - `display_name` string, required
      - `description` string, nullable
      - `data_type` 'short_text' | 'number' | 'date' | 'datetime' | 'boolean' | 'enum' | 'enum_multi' | 'reference', required
      - `reference_type` string, nullable
      - `validation` object, nullable
      - `default_format` string, nullable
      - `default_value` union — Raw custom field value (type depends on definition)
        - string
        - number
        - boolean
        - string[]
        - object
  - `links` LinkSelf
    - `self` string, uri

## Changes

- **2026-07-02** `3857867d53f2` — 1 warning, 1 info
  - added the new `Container` enum value to the `data/attributes/entity_type` response property for the response status `200`
  - removed the `Cargo` enum value from the `data/attributes/entity_type` response property for the response status `200`
- **2026-05-20** `3b798d71b259` — 1 warning, 1 info
  - added the new `Cargo` enum value to the `data/attributes/entity_type` response property for the response status `200`
  - removed the `Container` enum value from the `data/attributes/entity_type` response property for the response status `200`
- **2026-03-30** `ba531dc63989` — 2 warning, 1 info
  - added the new `Container` enum value to the `data/attributes/entity_type` response property for the response status `200`
  - added the new `TrackingRequest` enum value to the `data/attributes/entity_type` response property for the response status `200`
  - removed the `Cargo` enum value from the `data/attributes/entity_type` response property for the response status `200`
- **2026-02-26** `c5b7c05cda4c` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/terminal49/apis/terminal49-api-reference/changes/custom_field_definitions/:id/patch.md)

---

[API](https://skmtc.dev/terminal49/apis/terminal49-api-reference.md) · [All operations](https://skmtc.dev/terminal49/apis/terminal49-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/terminal49/terminal49-api-reference/revisions/998a27e39c03/schema)