Skip to main content

Rename Lark Base table

Sophie avatar
Written by Sophie
Updated this week

Definition and Usage

Change the name of a specified table within a Lark Base. You can locate the table either by its current name or by its unique ID, then provide the new name to apply. Use the locating mode that best fits your workflow: “By name” for readability or “By ID” for precision when names may not be unique.

Parameter Values

Input Parameters

Parameter Name

Description

Possible Values

Required

Options / Notes

Lark Base

Select the connected Lark Base instance to operate on.

Lark Base object

Yes

Must come from a prior Connect Lark Base step; ensure the connection is valid and authorized.

Locating mode

Choose how to identify the target table.

By name, By ID

Yes

Determines which field below is used; choose “By ID” to avoid ambiguity when duplicate names exist.

Data table name

Current name of the table to rename.

Text

Required when locating by name

Case and spacing must match exactly; ensure the table exists in the selected base.

Data table ID

Unique ID of the table to rename.

Text/ID

Required when locating by ID

Prefer when names are duplicated or localized; copy the exact ID from Lark Base.

New name

New table name to apply.

Text

Yes

Use a name compliant with your naming standards; avoid leading/trailing spaces.

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 previous steps into this command’s fields. If the UI shows an {x} indicator for a field, it supports variables—use it to inject values like the table name, table ID, or new name at runtime. This is useful when selecting the Lark Base from an earlier connection step or when renaming tables based on upstream logic.

Notes

  • Ensure you have already connected to the correct Lark Base before running this command.

  • Choose the locating mode carefully: use “By ID” to avoid renaming the wrong table when multiple tables share the same name.

  • The table must exist; renaming will fail if the specified name or ID doesn’t match a table in the selected base.

  • Confirm the new name meets any organizational or platform naming rules; avoid reserved characters if applicable.

  • Consider race conditions: if another process renames or deletes the table concurrently, the command may fail—add retries if needed.

Did this answer your question?