Definition and Usage
Use Update field to modify a field in a Lark Base data table. You can select the target data table and field either by name or by ID, then update the field’s name, type, and description. Choose the appropriate locate mode first (By name or By ID) for both the data table and the field to precisely target what you need to change.
Parameter Values
Input Parameters
Parameter Name | Description | Possible Values | Required | Options / Notes |
Lark Base | The connected Lark Base session to operate on. | Lark Base object | Yes | Must be created by Connect Lark Base beforehand. |
Data table locate mode | How to identify the data table to update. | By name, By ID | Yes | Choose By ID for reliability when names can change or duplicate. |
Data table name | Name of the data table to update. | Text | Conditional | Required when locate mode is By name; leave empty if using By ID. |
Data table ID | ID of the data table to update. | Text | Conditional | Required when locate mode is By ID; leave empty if using By name. |
Field locate mode | How to identify the field to update. | By name, By ID | Yes | Use By ID to avoid ambiguity when fields share names. |
Field name | Name of the field to update. | Text | Conditional | Required when locate mode is By name; leave empty if using By ID. |
Field ID | ID of the field to update. | Text | Conditional | Required when locate mode is By ID; leave empty if using By name. |
New field name | The new name for the field. | Text | No | Leave blank to keep the current name; ensure uniqueness if your schema requires it. |
New field type | The new data type for the field. | Text; Number; Single Choice; Multiple Choice; Date; Check Box; Personnel; Phone Number; Hyperlink; Annex; Unidirectional Association; Formula; Bidirectional Association; Geographic Location; Group; Creation Time; Last updated; Creator; Modifier; Auto Number | No | Changing type may affect existing data and formulas; verify compatibility before changing. |
New field description | The new description/help text for the field. | Text | No | Use for documentation or guidance; leave blank to keep existing description. |
Advanced Settings
No advanced settings available.
Error Handling
Parameter Name | Description |
Throw error & stop | When an error occurs, the action will stop execution. |
Retry command | The action retries the command if an error occurs. |
Ignore error & continue | The action ignores the error and continues workflow execution. |
Variables Produced
This action doesn't produce any variables.
Using Variables in Conditions
You can pass dynamic values from earlier steps into this command. For example, you might use variables to supply the data table ID, field ID, or new field name produced by previous actions. If the UI shows {x} for a field, it indicates the field supports variables. Combine this with condition steps to update different fields based on prior logic or data lookups.
Notes
Connect to Lark Base before using this command and ensure the connection is valid.
Use ID-based locating for stable, unambiguous targeting, especially across environments or renamed items.
Ensure you have permission to modify schema (field settings) in the target data table.
Changing field type can cause data loss or incompatibility; review downstream dependencies (views, formulas, integrations) before updating.
System-related field types (e.g., Creation Time, Creator) may have restrictions on editing; validate allowed changes in your workspace.
If both name and ID are provided for a locate mode, only the selected mode applies; keep the unused field empty to avoid confusion.