Lark Sheets icon

Lark Sheets

Lark Sheets Management

Overview

The "Create Spreadsheet" operation in the Lark Sheets node allows users to create a new spreadsheet document within a specified folder in Lark's Docs Sheets service. This is useful for automating the generation of spreadsheets as part of workflows, such as creating reports, logs, or data collection templates dynamically.

Typical use cases include:

  • Automatically generating a new spreadsheet in a project folder when a new task or event occurs.
  • Creating template spreadsheets with predefined titles for team collaboration.
  • Integrating with other systems to log data into newly created sheets without manual intervention.

Properties

Name Meaning
Authentication Method used to authenticate API requests. Options: "Tenant Token" or "OAuth2".
Folder Token Identifier token of the folder where the new spreadsheet will be created.
Title The title (name) of the new spreadsheet document to be created.
Use Custom Body Boolean flag indicating whether to send a custom JSON body instead of the standard fields.
Custom Body A JSON object allowing full customization of the request body sent to the API.

Output

The node outputs JSON data representing the response from the Lark Sheets API after creating the spreadsheet. This typically includes metadata about the newly created spreadsheet such as its unique identifier, URL, and other relevant details.

If binary data were involved (e.g., file content), it would be indicated here, but this operation focuses on JSON metadata output only.

Dependencies

  • Requires an active connection to Lark Suite's Open APIs.
  • Needs either a Tenant Token or OAuth2 authentication configured in n8n credentials.
  • The base URL for API requests is https://open.larksuite.com/open-apis.
  • Proper permissions on the folder identified by the Folder Token to create new spreadsheets.

Troubleshooting

  • Invalid Folder Token: If the folder token is incorrect or the user lacks permission, the API will return an error. Verify the folder token and ensure the authenticated user has write access.
  • Authentication Errors: Using expired or invalid tokens will cause authentication failures. Refresh or reconfigure credentials as needed.
  • Missing Required Fields: Omitting the title or folder token will result in API errors. Ensure these fields are correctly set unless using a fully custom body.
  • Custom Body Misconfiguration: When "Use Custom Body" is enabled, the JSON must be valid and contain all required fields; otherwise, the API may reject the request.

Links and References

Discussion