Fields: update
fields_updateDestructive
Update an existing field's label, description, display type, default, options and its required, searchable, public or indexed flags, keeping any settings you don't pass.
Instructions
Update properties of an existing field. Changes a field's label, description, display type, default value, select options and its required, searchable, public-search and indexed flags. Settings you don't pass keep their value, except the description, which is cleared unless passed again. It cannot rename a field or change its database type, and locked fields are refused. It changes or deletes existing data, so check with the user before running it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| label | No | Human-readable label | |
| entity | Yes | Entity name | |
| public | No | Mark field as publicly searchable | |
| default | No | Default value | |
| display | No | Display type: input, textarea, rich-text, select, entity-select, radio, country-select, checkbox, short-date, long-date, timestamp, relationship, file, secret, user, jsonb, geo, dynamic-reference | |
| indexed | No | Add database index | |
| options | No | Comma-separated option list for select display, e.g. "Running,Cycling,Rugby". Use label=value to split, e.g. "Running=running,Cycling=cycling" | |
| multiple | No | Allow multiple values on a select field | |
| required | No | Mark field as required | |
| no_public | No | Remove public searchable flag | |
| field_name | Yes | Field name to update | |
| no_indexed | No | Remove database index | |
| searchable | No | Enable full-text search on this field | |
| description | No | Field description | |
| no_multiple | No | Restrict to a single value on a select field | |
| no_required | No | Remove required constraint | |
| no_searchable | No | Disable full-text search on this field |