update_custom_field
Idempotent
Modify a custom field definition by updating its name or extra_data, including monetary currency and select options. Preserve existing select options by including their IDs to avoid deletion.
Instructions
Patch selected fields on a custom field definition.
extra_data shape depends on data_type:
monetary— optional{"default_currency": "USD"}(ISO-4217).select—extra_data.select_optionsreplaces the current list wholesale. To preserve existing values, include each existing option with its server-assignedid:{"select_options": [{"id": "abc", "label": "Low"}, ...]}. Omitting an option'sidcreates a new option; dropping an option from the list deletes it and any document values referencing it.
See create_custom_field for the full extra_data shape table.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| patch | Yes | ||
| field_id | Yes |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| name | Yes | ||
| data_type | Yes | ||
| extra_data | No |