Definition and Usage
Add Lark Base field adds a new field to a specific table in Lark Base. You can target the table by its name or unique ID, then define the field’s name, type, and optional description. Use this action after establishing a connection to Lark Base. Choose the locating mode carefully: provide either the table name or the table ID based on your selection.
Parameter Values
Input Parameters
Parameter Name | Description | Possible Values | Required | Options / Notes |
Lark Base | The connected Lark Base object to operate on. | A Lark Base object from Connect Lark Base | Yes | Must be created by Connect Lark Base in a prior step. |
Locating mode | How to specify which table receives the new field. | By name, By ID | Yes | Determines whether you fill Data table name or Data table ID. |
Data table name | Name of the target table where the field will be added. | Any existing table name | Conditional | Required when Locating mode = By name; ensure exact match and correct workspace/base. |
Data table ID | Unique ID of the target table where the field will be added. | Any valid table ID | Conditional | Required when Locating mode = By ID; copy from Lark Base to avoid typos. |
Field name | Name of the new field to create. | Any valid field name | Yes | Must be unique within the table; follow your naming conventions. |
Field type | Data type of the new 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 | Yes | Some types may require additional configuration later in Lark Base (e.g., options for choices). |
Field Description | Optional description for the new field. | Any text | No | Use to document purpose and usage; helpful for team handoffs. |
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 can store details of the newly created field for later steps. Save it to reuse the field when updating records, configuring related fields, or logging results across your workflow.
Using Variables in Conditions
You can pass dynamic values from earlier steps to this command, such as selecting the Lark Base object, table identifiers, or the field name. If the UI marks inputs with {x}, those fields support variables. Use variables to:
Choose the target table by a name or ID obtained in previous steps.
Generate field names dynamically (e.g., timestamped names).
Store the newly created field and reference it in subsequent actions.
Notes
Connect to Lark Base first; ensure you select the same connection here.
Choose one locating method: provide the table name when using By name, or the table ID when using By ID.
Field names must not conflict with existing fields in the table.
Some field types (e.g., Single Choice, Multiple Choice, Associations, Formula) may need further configuration inside Lark Base after creation.
Permissions in Lark Base must allow schema changes; otherwise, the command will fail.
Using an incorrect table name or ID will cause the action to fail; prefer IDs for reliability.