Events

By default, returns a list of all unarchived Events in your Organization.

To list Events in a specific time window, include the window_start and window_end query parameters. Note that Events that start or end within the specified time window will be included, regardless of if they end after or start before the window, respectively. Events that start before the window and end after the window will also be included.

To list archived Events, use the /events/archive endpoint.

This endpoint supports both singular and bulk creation of Events.

Create an Event

Creates an Event based on the provided fields.

You can optionally include a notification object to trigger an email notification informing recipients of the creation of this Event.

Bulk create Events

Creates Events based on the provided fields.

You can optionally include a notification object for each Event to trigger an email notification informing recipients of the creation of that Event.

Deletes the specified Events. Archived Events cannot be deleted. Note that, in a break from standard HTTP API patterns, this endpoint requires a JSON request body to specify the Events to delete.

You can optionally include a notification object for each Event to trigger an email notification informing recipients of the deletion of that Event. Note that, regardless of the inclusion or exclusion of the notification object, if an Event was created by a Booking, an email notification will be sent to the booker (the end-user) informing them their Booking has been canceled.

If an Event was created by a Booking, deleting the Event will also cancel the Booking.

Updates the specified Events by setting the values of the fields passed. Any fields not provided will be left unchanged. By design, you cannot change an Event's id.

You can optionally include a notification object for each Event to trigger an email notification informing recipients of the update of that Event. Note that, regardless of the inclusion or exclusion of the notification object, if that Event was created by a Booking, an email notification will be sent to the booker (the end-user) if fields included in the initial Booking were updated.

Returns a list of archived Events in your Organization in a specific time window.

Retrieves the Event with the given id.

Deletes the specified Event. Archived Events cannot be deleted. Note that, in a break from standard HTTP API patterns, this endpoint requires a JSON request body to support email notifications.

You can optionally include a notification object to trigger an email notification informing recipients of the deletion of this Event. Note that, regardless of the inclusion or exclusion of the notification object, if this Event was created by a Booking, an email notification will be sent to the booker (the end-user) informing them their Booking has been canceled.

If this Event was created by a Booking, deleting the Event will also cancel the Booking.

Updates the specified Event by setting the values of the fields passed. Any fields not provided will be left unchanged. By design, you cannot change an Event's id.

You can optionally include a notification object to trigger an email notification informing recipients of the update of this Event. Note that, regardless of the inclusion or exclusion of the notification object, if this Event was created by a Booking, an email notification will be sent to the booker (the end-user) if fields included in the initial Booking were updated.