Lark Calendar icon

Lark Calendar

Lark Calendar Management

Actions32

Overview

The "Update A Calendar" operation in the Lark Calendar node allows users to modify existing calendar details such as color, description, permissions, summary, and summary alias. This is useful for keeping calendar metadata up-to-date or customizing calendar appearance and access control dynamically within an automation workflow.

Practical examples include:

  • Changing the calendar color to visually distinguish it.
  • Updating the calendar description to reflect new information or purpose.
  • Modifying permissions to adjust who can view or edit the calendar.
  • Renaming the calendar summary or its alias for clarity.

Properties

Name Meaning
Authentication Method of authentication: either "Tenant Token" or "OAuth2".
Calendar Id The unique identifier of the calendar to update.
Color Numeric value representing the calendar's color.
Description Text description of the calendar.
Permissions String defining the calendar's permissions settings.
Summary The main title or name of the calendar.
Summary Alias An alternative name or alias for the calendar.
Custom Body JSON object allowing a fully custom request body to be sent instead of individual fields.
Options > Use Custom Body Boolean flag to toggle between using individual fields or sending a custom JSON body.

Output

The node outputs JSON data representing the updated calendar object returned by the Lark API. This typically includes the updated properties such as color, description, permissions, summary, and summary alias reflecting the changes made.

No binary data output is involved in this operation.

Dependencies

  • Requires an API authentication token, either via a tenant token or OAuth2 credentials configured in n8n.
  • Connects to the Lark Suite Open APIs endpoint at https://open.larksuite.com/open-apis.
  • Proper permissions on the API credentials are necessary to update calendar details.

Troubleshooting

  • Invalid Calendar Id: If the calendar ID is incorrect or does not exist, the API will return an error. Verify the calendar ID from the source system or Lark documentation.
  • Authentication Errors: Using invalid or expired tokens will cause authentication failures. Ensure that the API credentials are valid and have the required scopes.
  • Permission Denied: Insufficient permissions on the calendar or API token may result in permission errors. Confirm that the token has rights to update the specified calendar.
  • Malformed Custom Body: When using the custom body option, ensure the JSON is correctly formatted and contains valid fields expected by the API.

Links and References

Discussion