Skip to main content
Events use the same endpoints as appointments, with time_slot_type set to event and patient set to null. See The Appointment Object.

In the EHR

Events appear on the Calendar alongside appointments. A Calendar Block reserves time so that nothing can be booked over it, while a Non-blocking Placeholder marks time without making it unavailable. See the Calendar Guide.

Working with events via the API

Events created through the API are Calendar Blocks. is_blocking is read-only and true on every event the API creates, so the time is unavailable for booking. Create Non-blocking Placeholders on the Calendar. A reason links the event to an appointment type. POST and PUT requests must include reason or appointment_type_id. A non-null reason matches or creates an appointment type in the same way it does for appointments, and that type’s default duration and telehealth setting then apply to the event. Send "reason": null unless the event should carry an appointment type.