Update field
update_fieldPatch a custom field by object_type + key — change its label or choice options. Returns the updated field definition.
When to use: When an admin wants to rename a custom field or change its choice options.
Example: Add 'reseller' to the partner_type field's options.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| key | Yes | The custom field's key (from describe_schema), not its label. | |
| label | No | New display label. The key does not change. | |
| options | No | Replaces the whole choice list of a select/multiselect field, as labels; a choice field must keep at least one option. | |
| object_type | Yes | Object key the field belongs to (built-in or custom). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| field | No |