Skip to main content

Delete Field

Sophie avatar
Written by Sophie
Updated this week

Definition and Usage

Delete Field removes a specific field from a Lark Base data table. You choose the target table either by name or by ID, and then select the field to delete by name or ID. Use this command when you need to clean up schemas or automate table maintenance in Lark Base.

Parameter Values

Input Parameters

Parameter Name

Description

Possible Values

Required

Options / Notes

Lark Base

The connected Lark Base instance to operate on.

A Lark Base object

Yes

Obtain this from a prior Connect Lark Base step; ensure the connection is valid.

Data table locate mode

How to identify the target data table.

By name, By ID

Yes

Choose By name when names are unique; use By ID for reliability across renames.

Data table name

Name of the data table to modify.

Text

Conditional

Required when Data table locate mode = By name; must match exactly.

Data table ID

ID of the data table to modify.

Text

Conditional

Required when Data table locate mode = By ID; copy from Lark Base to avoid typos.

Field locate mode

How to identify the field to delete.

By name, By ID

Yes

Choose By ID to avoid ambiguity; names must be exact and case-sensitive if applicable.

Field name

Name of the field to delete.

Text

Conditional

Required when Field locate mode = By name; ensure the field exists before deletion.

Field ID

ID of the field to delete.

Text

Conditional

Required when Field locate mode = By ID; safest option for stable automation.

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, use variables to supply the data table name or ID returned by a previous lookup, or to select the field ID discovered at runtime. If the UI marks a field with {x}, it indicates that field accepts variables. Combine this with conditional logic in your workflow to delete fields only when certain criteria are met.

Notes

  • Ensure you have already connected to Lark Base using the Connect Lark Base command before running this action.

  • Deleting a field is irreversible and removes its data from the table; confirm the target before execution.

  • Prefer identification By ID for both tables and fields to avoid issues with renamed or duplicate names.

  • The command will fail if the specified table or field does not exist or if you lack permissions.

  • If dependencies (e.g., formulas, views, or automations) reference the field, deletion may be blocked by the service.

Did this answer your question?