Lark Base icon

Lark Base

Lark Base Management

Actions21

Overview

The "Update Field" operation in the "Field" resource allows users to modify the properties of a specific field within a table in a bitable app on the Lark platform. This node is useful when you need to programmatically update metadata about fields, such as changing the field's name or type, without manually editing the bitable interface.

Common scenarios include:

  • Automating schema changes in a bitable app as part of a data pipeline.
  • Synchronizing field definitions across multiple tables or apps.
  • Dynamically adjusting field types or names based on external triggers or workflows.

For example, you might use this node to rename a field from "Status" to "Current Status" or change its type from text to number during an automated update process.

Properties

Name Meaning
Authentication Method of authentication to access the API. Options: Tenant Token, OAuth2
App Token The token identifying the bitable app where the field exists.
Table Id Identifier of the table containing the field to update.
Field Id Identifier of the field to be updated.
Field Name New name for the field (optional if using custom body).
Type New type for the field represented as a number (optional if using custom body).
Custom Body JSON object allowing full customization of the request body sent to the API.
Options > Use Custom Body Boolean flag indicating whether to send a fully custom JSON body instead of individual parameters.

Output

The node outputs JSON data representing the response from the Lark bitable API after updating the field. This typically includes confirmation of the updated field properties and any relevant metadata returned by the API.

If the API supports binary data in responses (not indicated here), it would be summarized accordingly, but this node primarily deals with JSON data.

Dependencies

  • Requires valid authentication credentials via either a tenant token or OAuth2 token.
  • Needs the bitable app token, table ID, and field ID to identify the target field.
  • Relies on the Lark Suite Open API endpoint at https://open.larksuite.com/open-apis.
  • No additional environment variables are explicitly required beyond standard n8n credential setup.

Troubleshooting

  • Invalid App Token, Table Id, or Field Id: Ensure these identifiers are correct and correspond to existing resources in your Lark bitable app.
  • Authentication Errors: Verify that the selected authentication method is properly configured and tokens are valid.
  • API Request Failures: If using a custom body, ensure the JSON structure matches the API specification; malformed JSON or incorrect property names can cause errors.
  • Permission Issues: The authenticated user or token must have sufficient permissions to update fields in the specified app and table.
  • Validation Errors: For example, the App Token must match the regex pattern [a-zA-Z0-9]+. Invalid formats will be rejected.

Links and References

Discussion