Change a field
heliyos_fields_updateUpdates one field of a CRM object by field_id, letting you change its label, description, options, required or hidden flag, AI prompt, or type while keeping the field key unchanged.
Instructions
Changes one field of an object by field_id (from heliyos_objects_get): its label, description, options, required or hidden flag, AI prompt, or type. What you leave out is kept. options REPLACES the allowed values, and records holding a removed value keep it as stale text. A type change is refused by the platform when existing values do not fit the new type. The field key never changes. Returns structuredContent {field}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | New type; values must fit it. | |
| label | No | Display name, for example "Contract value". | |
| hidden | No | true: hidden from the web app's tables by default. | |
| options | No | Allowed values of a select or multiSelect field, unique. | |
| field_id | Yes | field_id: a 24-character hex id. | |
| required | No | true: records must have a value. | |
| ai_prompt | No | Makes this an AI column: the workers fill it from this prompt (text, richText, number, date, select, multiSelect or checkbox only). Filling existing records is started from the Heliyos web app and uses credits. | |
| schema_id | No | Object schema id. Required when object_type is "custom"; the error lists the available ones. | |
| description | No | What the field holds; shown in the web app and read by the workers. | |
| object_type | Yes | Which object: "company", "person", "deal", or "custom" (custom objects also need schema_id). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| field | Yes |