The Calendar Events API manages the custom events on a site's marketing calendar. A calendar event is something a site owner wants their marketing to revolve around, such as a sale, holiday, product launch, or business milestone. When the AI generates a marketing plan, it uses these events as context and builds activities around them. The events themselves don't create activities directly.
With the Calendar Events API, you can:
- Create one-time or recurring events.
- Retrieve events within a date range, including read-only events from the site's connected calendars (such as Google Calendar).
- Update and delete site-managed events.
It's important to note the following points before starting to code:
- Events shape a plan the next time it's generated or regenerated. Adding an event doesn't change an existing plan on its own.
- An event is either one-time, with a single date, or recurring, with a rule that repeats weekly, monthly, or yearly.
- Query Events also returns read-only events from the site's connected calendars (such as Google Calendar). These events can't be updated or deleted through this API.
- Calendar event: A custom event on the marketing calendar, such as a sale or holiday, used as context when generating a plan.
- Recurring rule: A rule that makes an event repeat on a weekly, monthly, or yearly schedule.