A collection of events associated with a specific entity, such as a Bookings service, or Bookings resource. Schedules can also serve as templates for the events they manage, setting default values like a default location.
Schedule ID.
Schedule name.
Min: 1 character Max: 200 characters
Schedule status.
Supported values:
ACTIVE: You can add events to the schedule or update its fields.CANCELLED: You can't add events to the schedule or update its fields.Default: ACTIVE
Time zone the schedule is associated with in
IANA tz database format.
For example, America/New_York.
Default: timeZone specified in the business site properties.
Min: 1 character Max: 150 characters
Whether the schedule's timeZone is automatically synced from
timeZone of the business site properties.
Default: true
Default title for events
that are added to the schedule.
Min: 1 character Max: 200 characters
Default location for events
that are added to the schedule.
Default totalCapacity for events
that are added to the schedule.
Min: 0
Default conferencingDetails for events
that are added to the schedule.
Returned only if explicitly requested. For more details, see the permissions article.
ID of the app that's associated with the schedule. You can't update appId.
If you want to create a schedule and ensure its associated events appear
in the Bookings calendar,
you must provide the Wix Bookings app ID
13d21c63-b5ec-5912-8397-c3a5ddb27a97.
List of permissions associated with the schedule. Refer to the permissions article for more information.
Max: 1 permission
Extensions enabling applications or users to save custom data related to the schedule.
Revision number, which increments by 1 each time the schedule is updated. To prevent conflicting changes, the current revision must be passed when updating the schedule. Ignored when creating a schedule.
Date the schedule was created in YYYY-MM-DDThh:mm:ss.sssZ format.
Date the schedule was last updated in YYYY-MM-DDThh:mm:ss.sssZ format.