Create AddEvent Event
addevent_create_eventCreate a new event on your AddEvent calendar. Provide a title and start time, then add optional details like location, recurrence, or reminders to get an event ID and public landing page URL.
Instructions
Creates a new event on an AddEvent calendar.
Args:
title (string, required): The event's title.
calendar_id (string, optional): Target calendar. Defaults to the account's default calendar. Use addevent_search_calendars to find IDs.
datetime_start (string, required): Start date/time, e.g. "2026-09-15 18:00" or "2026-09-15" for a date-only event.
datetime_end (string, optional): End date/time. Defaults to datetime_start + 1 hour.
all_day_event, timezone, recurring_rule, description, internal_name, location, location_id, organizer_name, organizer_email, reminder, color, free_busy, landing_page_template_id, rsvp_enabled, rsvp_form_id, custom_data: optional fields, see each field's description.
Returns: The created event object as JSON, including its event_id and public landing_page_url.
Examples:
"Create the Main Monthly meetup for Sept 15 at 6pm at [venue]" -> title, datetime_start, location set.
"Make it a recurring event, third Tuesday of every month" -> recurring_rule: "FREQ=MONTHLY;BYDAY=3TU".
Don't use when: the event already exists (use addevent_update_event instead).
Error Handling:
Returns a clear message if required fields are missing, the calendar_id doesn't exist, or the API rejects the request body (400).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| color | No | Event color, 1 to 20, matching the calendar's palette. Default 1. | |
| title | Yes | The event's title. Must be a non-empty, single-line string. | |
| 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 | Yes | 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. |