Update AddEvent Event
addevent_update_eventUpdate an existing event by providing only the fields to change—like datetime or location—so the rest of the event remains untouched.
Instructions
Updates an existing event. Only the fields you provide are changed; everything else is left as-is.
Args:
event_id (string, required): The event to update.
Any other field from addevent_create_event (title, datetime_start, datetime_end, location, description, etc.) is optional here — include only what's changing.
Returns: The updated event object as JSON.
Examples:
"Move the Main Monthly meetup to 7pm" -> event_id set, datetime_start updated.
"Change the location to the new venue" -> event_id set, location updated.
Don't use when: the event doesn't exist yet (use addevent_create_event).
Error Handling:
Returns "Error: Not found..." (404) if event_id doesn't exist, or "Error: Invalid request..." (400) if a field value fails validation.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| color | No | Event color, 1 to 20, matching the calendar's palette. Default 1. | |
| title | No | The event's title. Must be a non-empty, single-line string. | |
| event_id | Yes | The ID of the event to update. | |
| location | No | Address or URL (e.g. a Zoom link). Mutually exclusive with location_id. | |
| reminder | No | Minutes before the event to send a reminder, 0 to 10800. Default 30. Only honored by Apple Calendar, Outlook desktop, and Office 365/Outlook.com. | |
| timezone | No | IANA-style timezone (e.g. 'America/Denver') or 'floating' for a time that stays the same on every viewer's local clock. Defaults to the calendar's timezone. Use addevent_list_timezones for supported values. | |
| free_busy | No | Whether the event blocks the attendee's calendar: 'free', 'busy', or 'default' (use their default setting). | |
| calendar_id | No | The calendar this event belongs to. Defaults to the account's default calendar if omitted. Use addevent_search_calendars to find calendar IDs. | |
| custom_data | No | Arbitrary key-value metadata to attach to the event, e.g. an external ID linking back to GHL. Use snake_case keys. | |
| description | No | Plain text or simplified HTML description. Keep to roughly 500 characters or fewer for cross-browser compatibility. | |
| location_id | No | ID of a saved location. Mutually exclusive with location. | |
| datetime_end | No | End date/time, same format as datetime_start. Defaults to datetime_start + 1 hour if omitted. | |
| rsvp_enabled | No | If true, attendees must RSVP before adding the event to their calendar. Default false. | |
| rsvp_form_id | No | Custom RSVP form ID, or 'default' for the standard form. | |
| all_day_event | No | If true, start/end times are ignored and only the date is used. Default false. | |
| internal_name | No | Internal-only label, never shown publicly. Useful for a human-readable label or an external ID linking back to another system. | |
| datetime_start | No | Start date/time, e.g. '2026-09-15 18:00' or '2026-09-15' for a date-only event. | |
| organizer_name | No | Organizer's name. Must be paired with organizer_email. | |
| recurring_rule | No | iCalendar RRULE string for a repeating event (e.g. 'FREQ=MONTHLY;BYDAY=3TU' for the third Tuesday of every month). Leave empty for a one-time event. datetime_start must align with the rule for strict clients like Outlook desktop and Apple Calendar. Not supported by Yahoo Calendar. | |
| organizer_email | No | Organizer's email. Must be paired with organizer_name. Including an organizer makes calendar clients like Outlook desktop treat this as a meeting rather than an appointment. | |
| landing_page_template_id | No | Custom event landing page template ID, or 'default' for the standard AddEvent template. |