Update Custom Field
update_custom_fieldModifies an existing custom field's settings, such as name, default value, required status, display options, and type constraints, without changing its type or workspace.
Instructions
Update a custom field definition. Only the parameters you pass are changed. The field's type, apply_to and workspace cannot be changed; create a new field instead.
Requires the Custom Fields Admin role (or Global Admin).
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"custom_field_id": "<custom_field_id>"
},
"name": "update_custom_field"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | The new name. | |
| required | No | Whether a value must be given. | |
| display_list | No | Show the value as a pill in runbook and task lists. | |
| default_value | No | The value a new runbook or task starts with. | |
| display_table | No | Include the field in table views. | |
| task_type_ids | No | Replace the task type constraints with these task types. The runbook type constraints are kept. | |
| display_search | No | Allow filtering by this field. | |
| custom_field_id | Yes | The ID of the field to update (from list_custom_fields). | |
| runbook_type_ids | No | Replace the runbook type constraints with these runbook types. The task type constraints are kept. The Cutover API rejects an empty constraint list, so constraints cannot be cleared here; archive the field and create a new one instead. | |
| add_field_options | No | Option names to add to a select_menu, radiobox or checkboxes field. Existing options are kept. Options cannot be renamed or removed through the API. | |
| allow_field_creation | No | Let users add options from within a runbook. | |
| custom_field_group_id | No | Move the field into this group. Pass "" to take it out of its group. When omitted the field stays in its current group. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||