The Schedules API allows you to manage collections of
events.
Schedules allow you to easily manage events that are linked to the same entity, such as a
Bookings service
or Bookings resource.
You can also create schedules for custom entities beyond the Wix ecosystem.
Schedules set default values
for their events, ensuring consistency across all related events.
With the Schedules API, you can:
- Create and update schedules.
- Retrieve schedules.
- Cancel schedules permanently.
- Track in real-time when a schedule is created or modified.
For more in-depth scheduling management, see:
It’s important to note the following points before starting to code:
- The schedule object itself doesn’t store event details. Each event is independently managed.
- An event must belong to exactly one schedule.
- Once a schedule is marked as
CANCELLED, you can't reactivate, update, or associate it with new events.
- Recurring events aren't defined by the schedule itself. Instead, create a
MASTER event to establish the recurrence pattern.
- Schedule: Collection of events associated with a specific entity, such as a Bookings service, or Bookings resource. Schedules also serve as templates for the events they manage, setting default values like a default location.
- Status: Indicates whether a schedule can be updated or if it’s permanently
CANCELLED.
- Role: You can assign roles to Wix users
giving them specific access to the schedule.
- Writer: Can read and modify the schedule.
- Commenter: Can only read the schedule.
- Schedule time frame: Defines the first and last event dates within a schedule and indicates whether any events recur indefinitely.
- Event: A calendar entry that specifies details such as timing, location, and participants. Each event is associated with a schedule and may inherit its default values. Events can be standalone or part of a recurring series and can block time or allow concurrent scheduling on the calendar.