Actions32
- Calendar Actions
- Acl Actions
- Event Actions
- Event Attendee Actions
- Event Attendee Chat Member Actions
- Freebusy Actions
- Timeoff Actions
- Setting Actions
- Exchange Binding Actions
Overview
The "Update An Event" operation in the Lark Calendar node allows users to modify details of an existing calendar event. This is useful for scenarios where event information such as time, location, description, or attendees needs to be changed after the event has been created. For example, if a meeting time changes or additional participants are added, this operation updates the event accordingly.
Practical examples include:
- Changing the start and end times of a scheduled meeting.
- Updating the event description or summary to provide more context.
- Modifying the location details or adding video conferencing links.
- Adjusting reminders or notification settings for the event.
Properties
Name | Meaning |
---|---|
Authentication | Method of authentication to use: either "Tenant Token" or "OAuth2". |
Calendar Id | The unique identifier of the calendar containing the event. |
Event Id | The unique identifier of the event to update. |
Attendee Ability | Permissions or abilities assigned to attendees (e.g., can they modify the event). |
Color | Numeric value representing the color label of the event. |
Description | Text description providing details about the event. |
End Time | Object specifying the event's end time with fields: date (string), timestamp (string), and timezone (string). |
Free Busy Status | Status indicating availability during the event (e.g., free, busy). |
Location | Object describing the event location including address (string), latitude (number), longitude (number), and name (string). |
Need Notification | Boolean flag indicating whether notifications should be sent for this event. |
Recurrence | String defining recurrence rules for repeating events. |
Reminders | Array of reminder objects, each with a minutes field indicating how many minutes before the event to trigger a reminder. |
Schemas | Array of schema objects with fields app_link , ui_name , and ui_status for UI integration or app linking purposes. |
Start Time | Object specifying the event's start time with fields: date (string), timestamp (string), and timezone (string). |
Summary | Short text summary or title of the event. |
Vchat | Object containing video chat details: description , icon_type , meeting_url (URL string), and vc_type . |
Visibility | String indicating the visibility level of the event (e.g., public, private). |
Custom Body | JSON object allowing the user to specify a fully custom request body instead of using individual properties. |
Options > Use Custom Body | Boolean option to toggle between using the predefined properties or sending a custom JSON body. |
Output
The node outputs the updated event data in the json
field of its output. This typically includes all the event details after modification, reflecting the new state of the event on the calendar.
If binary data were involved (not indicated here), it would represent attachments or related files, but this operation focuses on JSON event data only.
Dependencies
- Requires access to the Lark Suite Open 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 calendar and event resources to perform update operations.
Troubleshooting
- Invalid Calendar or Event ID: Errors may occur if the provided calendar or event IDs do not exist or are incorrect. Verify these IDs carefully.
- Authentication Failures: Ensure that the selected authentication method is correctly configured and the token or OAuth credentials are valid and have sufficient scopes.
- Invalid Date/Time Format: The
start_time
andend_time
fields require properly formatted date, timestamp, and timezone strings. Incorrect formats may cause API errors. - Permission Denied: If the authenticated user lacks permission to update the event, the API will reject the request.
- Using Custom Body: When enabling the "Use Custom Body" option, ensure the JSON structure matches the API requirements exactly; otherwise, the request may fail.
Links and References
- Lark Suite Calendar API Documentation (for detailed info on calendar and event IDs, request bodies, and response structures)
- Date and Time Formats (recommended format for timestamps and dates)