Actions23
- Spreadsheet Actions
- Sheet Filter Actions
- Sheet Filter View Actions
- Filter Condition Filter View Actions
- Sheet Row Column Actions
- Sheet Data Actions
- Sheet Floating Image Actions
Overview
The "Update A Filter" operation in the "Sheet Filter" resource of the Lark Sheets node allows users to modify an existing filter on a specific sheet within a spreadsheet. This is useful for dynamically adjusting data views by changing filter criteria without manually editing the sheet.
Common scenarios include:
- Automating report generation where filters need to be updated based on user input or external conditions.
- Adjusting data visibility in shared sheets programmatically.
- Integrating with workflows that require conditional data filtering before further processing.
For example, you might update a filter to show only rows where the value in column "Status" equals "Completed", or change the filter condition to display entries after a certain date.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method of authenticating API requests. Options: Tenant Token, OAuth2. |
| Spreadsheet Token | The unique token identifying the target spreadsheet. Required to specify which spreadsheet contains the sheet to update. |
| Sheet Id | Identifier of the specific sheet within the spreadsheet where the filter will be updated. |
| Col | The column identifier (e.g., letter or number) on which the filter condition applies. |
| Condition | Defines the filter condition to apply. It includes: - compare_type: The comparison operator (e.g., equals, greater than).- expected: One or more expected values to compare against.- filter_type: Type of filter applied. |
| Custom Body | JSON object allowing full customization of the request body sent to the API. When enabled, this overrides other property inputs for the request body. |
| Options > Use Custom Body | Boolean flag indicating whether to use the Custom Body field instead of the standard properties for the request payload. |
Output
The node outputs JSON data representing the response from the Lark Sheets API after updating the filter. This typically includes confirmation of the updated filter settings or error details if the update failed.
If the API supports binary data output (not indicated here), it would represent related file or sheet content, but this operation primarily deals with JSON responses.
Dependencies
- Requires access to the Lark Suite API endpoint at
https://open.larksuite.com/open-apis. - Requires authentication via either a Tenant Token or OAuth2 credentials configured in n8n.
- Proper permissions on the spreadsheet and sheet to update filters are necessary.
Troubleshooting
- Invalid Spreadsheet Token or Sheet Id: Ensure the tokens and IDs provided correspond exactly to existing resources in Lark Sheets.
- Authentication Errors: Verify that the selected authentication method is correctly configured and the credentials are valid.
- Malformed Condition Object: The
conditionproperty must follow the expected structure; incorrectcompare_type, missingexpectedvalues, or invalidfilter_typecan cause API errors. - Using Custom Body: If enabling the custom body option, ensure the JSON is well-formed and matches the API's expected schema to avoid request failures.
- API Rate Limits or Permissions: Check for API limits or insufficient permissions if updates fail unexpectedly.