Actions28
- File Actions
- Multipart Upload File Actions
- Permission Member Actions
- Permissionpublic Actions
- Statistic Actions
- Media Actions
- Multipart Upload Media Actions
- Comment Actions
- Subscription Actions
- Document Import Actions
Overview
The "Add A Comment" operation in the "Comment" resource of the Lark Files node allows users to add comments to documents managed within the Lark suite. This is useful for collaborative document editing and review workflows where team members need to leave feedback, questions, or notes directly on files.
Typical use cases include:
- Adding a new comment thread to a document.
- Replying to existing comments with detailed content.
- Marking comments as solved or unsolved.
- Tracking metadata such as creation time, update time, and user IDs involved in commenting.
For example, a project manager can automate adding review comments to a shared document after an automated check, or a support bot can append comments to documentation based on user queries.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method of authentication to use: either "Tenant Token" or "OAuth2". |
| File Type | The type of the document (string). Optional parameter used to specify the document format or category. |
| File Token | Required. The unique token identifying the document to which the comment will be added. |
| Comment Id | Identifier of the comment (string). Used when referencing or updating a specific comment. |
| Create Time | Timestamp (number) indicating when the comment was created. |
| Is Solved | Boolean flag indicating whether the comment has been marked as solved (true) or not (false). |
| Reply List | JSON object representing the list of replies to the comment. Each reply contains structured content elements such as text runs, links, and person references. |
| Solved Time | Timestamp (number) indicating when the comment was marked as solved. |
| Solver User Id | User ID (string) of the person who solved the comment. |
| Update Time | Timestamp (number) indicating when the comment was last updated. |
| User Id | User ID (string) of the person who created the comment. |
| Custom Body | JSON object allowing the user to provide a fully custom request body for the API call instead of using individual fields. This enables advanced usage scenarios where the default parameters are insufficient. |
| Options > Use Custom Body | Boolean option to toggle between using the standard input properties or sending the custom JSON body as-is. |
Output
The node outputs JSON data representing the response from the Lark Files API after adding a comment. This typically includes details about the newly created comment such as its ID, timestamps, status flags, and any nested replies.
If binary data were supported, it would represent attachments or media related to comments, but this operation focuses on JSON comment data only.
Dependencies
- Requires an active connection to the Lark Suite Open APIs.
- Needs either a Tenant Token or OAuth2 credentials configured in n8n for authentication.
- The base URL for API requests is
https://open.larksuite.com/open-apis. - Proper permissions on the Lark tenant or user account to manage document comments.
Troubleshooting
- Missing or invalid File Token: The operation requires a valid file token to identify the document. Ensure the token is correct and corresponds to an accessible document.
- Authentication errors: Verify that the selected authentication method is properly configured and the credentials are valid.
- Invalid JSON in Reply List or Custom Body: When using JSON inputs, ensure the syntax is correct and matches the expected schema.
- API rate limits or permission issues: Check if the API quota is exceeded or if the authenticated user lacks rights to comment on the document.
- Use Custom Body conflicts: If "Use Custom Body" is enabled, other input fields are ignored. Make sure the custom JSON body is complete and correctly formatted.