Lark Base icon

Lark Base

Lark Base Management

Actions21

Overview

The node is designed to update a record in a table within the "Docs Bitable" resource of the Lark Suite platform. It allows users to modify specific fields of an existing record by specifying the table and record identifiers along with the new field values. This node is beneficial for automating updates to structured data stored in Lark's bitable documents, such as project management tasks, OKRs, or departmental data.

Practical examples include:

  • Updating the status or deadline of a task in a project management table.
  • Modifying the performer or department associated with a record.
  • Changing key results or descriptions linked to an OKR entry.

Properties

Name Meaning
Authentication Method of authentication to use: either "Tenant Token" or "OAuth2".
App Token The identifier token of the bitable app where the table resides.
Table Id The unique identifier of the table containing the record to update.
Record Id The unique identifier of the record to be updated.
Fields JSON object representing the fields to update in the record. Example structure includes keys like "performer", "corresponding OKR", and "department". The value for each key is typically an array or null.
Custom Body A custom JSON body to send instead of the standard fields object. Allows full control over the request payload. Example includes fields like "manpower", "performer", "description", "deadline", "completed", "status", and "department".
Options > Use Custom Body Boolean flag indicating whether to use the "Custom Body" property instead of the standard "Fields" property for the update request.

Output

The node outputs JSON data representing the response from the Lark Suite API after attempting to update the record. This typically includes confirmation of the updated record's details or error information if the update failed.

If binary data were involved (not indicated here), it would represent file attachments or similar content related to the record.

Dependencies

  • Requires access to the Lark Suite API endpoint https://open.larksuite.com/open-apis.
  • Needs valid authentication credentials, either a Tenant Token or OAuth2 token, configured in n8n.
  • Requires the App Token, Table Id, and Record Id to identify the target record.
  • The node depends on correct JSON formatting for the "Fields" or "Custom Body" input.

Troubleshooting

  • Invalid App Token, Table Id, or Record Id: Errors will occur if these identifiers are incorrect or do not exist. Verify their correctness in the Lark Suite environment.
  • Authentication Failures: Ensure that the selected authentication method is properly configured and the tokens are valid and have sufficient permissions.
  • Malformed JSON in Fields or Custom Body: If the JSON is invalid or does not match expected schema, the API may reject the request. Validate JSON syntax before execution.
  • API Rate Limits or Network Issues: Temporary failures might happen due to rate limiting or connectivity problems; retry after some time.
  • Using Custom Body Flag: If "Use Custom Body" is enabled but the JSON structure is incorrect, the update will fail. Double-check the custom JSON format.

Links and References

Discussion