Create Event

Creates an event.

Required fields

What you need to provide depends on the type of event:

• Single-occurrence event, for example a vacation day or one-off time block: Only event.scheduleId, event.start.localDate, and event.end.localDate are required. Don't include recurrenceRule, omitting it creates a single-occurrence event. All other fields like location, resources, and conferencingDetails are optional.
• Recurring MASTER event, for example weekly working hours: In addition to the fields above, you must also provide recurrenceRule with at least frequency and days. Currently only WEEKLY frequency is supported, and only a single day per event, for example ["MONDAY"].

The required parameters shown in the schema include fields that are conditionally required within their parent objects. For example, recurrenceRule.frequency is required only if you include recurrenceRule. For a minimal single-occurrence event, none of these parent objects are needed.

Recurring events

If you provide recurrenceRule, an event with {"recurrenceType": "MASTER"} is created. Then, you can't set start.localDate to a past date, though the time can be earlier on the same day. You can, however, create single-occurrence events for past dates.

You can't create an event with recurrenceType set to INSTANCE or EXCEPTION. INSTANCE events are generated automatically based on the recurrence rule in the relevant MASTER event. EXCEPTION events are automatically created when you update an INSTANCE event, which changes its recurrenceType to EXCEPTION.