Lark Base icon

Lark Base

Lark Base Management

Actions21

Overview

The node is designed to create a new field in a specified table within a "bitable" app on the Lark platform. It allows users to define the field's name and type, facilitating dynamic schema updates in collaborative databases or spreadsheets managed via Lark's Docs Bitable service.

This node is beneficial when automating database schema changes, such as adding new columns to tables based on workflow conditions or user input. For example, it can be used to add custom fields for tracking additional metadata in project management apps or CRM systems built on Lark's bitable.

Properties

Name Meaning
Authentication Method of authenticating API requests; options are Tenant Token or OAuth2
App Token The unique token identifying the bitable app where the field will be created
Table Id Identifier of the table within the bitable app where the new field will be added
Field Name The name of the new field to create
Type Numeric code representing the data type of the new field (e.g., text, number, date, etc.)
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 the custom JSON body instead of standard parameters

Output

The node outputs JSON data representing the response from the Lark Docs Bitable API after creating the field. This typically includes details about the newly created field such as its ID, name, type, and any metadata returned by the API.

No binary data output is involved.

Dependencies

  • Requires access to Lark Suite APIs with appropriate authentication.
  • Needs either a Tenant Token or OAuth2 credentials configured in n8n.
  • Requires the bitable app token and table ID to identify where the field should be created.
  • The base URL for API requests is https://open.larksuite.com/open-apis.

Troubleshooting

  • Invalid App Token or Table ID: Ensure that the provided tokens and IDs are correct and correspond to existing resources in Lark.
  • Authentication Errors: Verify that the selected authentication method is properly configured and has sufficient permissions.
  • Field Type Issues: The numeric type must match supported field types in Lark Docs Bitable; invalid values may cause API errors.
  • Custom Body Misconfiguration: When using the custom body option, ensure the JSON structure matches the API requirements exactly to avoid request failures.
  • Network or API Availability: Check network connectivity and Lark API status if requests fail unexpectedly.

Links and References

Discussion