Schedule Object


Properties
idstring

Schedule ID.


scheduleOwnerIdstring

ID of the schedule's owner entity. This may be a resource ID or a service ID.


timeZonestringRead-only

Schedule's time zone in Area/Location format. Read-only. Derived from the Wix Business time zone.


intervalsArray <RecurringInterval>deprecated

Deprecated. Please use the Sessions API instead.


titlestringmaxLength 6000

Default title for the schedule's sessions. Maximum length: 6000 characters.


tagsstringdeprecated

Deprecated. Tags for grouping schedules. These tags are the default tags for the schedule's sessions. The Wix Bookings app uses the following predefined tags to set schedule type: "INDIVIDUAL", "GROUP", and "COURSE". Once the schedule type is set using these tags, you cannot update it. In addition to the app's tags, you can create and update your own tags.


locationobject

Default location for the schedule's sessions.


capacityintegerminimum 1maximum 1000format int32

Maximum number of participants that can be added to the schedule's sessions. Must be at most 1 for schedule whose availability is affected by another schedule. E.g, appointment schedules of the Wix Bookings app.


rateobjectdeprecated

Deprecated. Please use the Booking Services V2 payment instead.


availabilityobjectdeprecated

Deprecated.


totalNumberOfParticipantsintegerRead-only

Number of participants registered to sessions in this schedule, calculated as the sum of the party sizes.


participantsArray <Participant>Read-only

Partial list* of participants which are registered to sessions in this schedule. Participants who are registered in the schedule are automatically registered to any session that is created for the schedule. To retrieve the full list of schedule participants please use the Query Extended Bookings API.


externalCalendarOverridesobjectdeprecated

Deprecated.


statusstringRead-only
3 enum supported values:
UNDEFINEDCREATEDCANCELLED

Schedule status.


createdstringRead-onlyformat date-time

Schedule creation date.


updatedstringRead-onlyformat date-time

Schedule last update date.


versionintegerRead-only

Schedule version number, updated each time the schedule is updated.


inheritedFieldsArray <string>Read-only

Fields which were inherited from the Business Info page under Settings in the Dashboard.


conferenceProviderobjectdeprecated

Deprecated.


calendarConferenceobjectdeprecated

A conference created for the schedule. This is used when a participant is added to a schedule. Partially deprecated. Only hostUrl and guestUrl are to be supported.

Was this helpful?
Yes
No