Schedule Object

Attributes
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. Please use the Sessions API instead.

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

tagsstring
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.

rateobject
Deprecated. Please use the Booking Services V2 payment instead.

availabilityobject
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.

externalCalendarOverridesobject
Deprecated.

statusstringRead-only
3 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.

conferenceProviderobject
Deprecated.

calendarConferenceobject
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

GetList Schedules

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Lists schedules by schedule IDs or schedule owner IDs.

Permissions This endpoint requires the Read Bookings Calendar or the Manage Bookings permission scope. With the Read Bookings Calendar permission scope, the schedule participants are not returned.

Was this helpful?
Yes
No

PostCreate Schedule

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Creates a schedule

Permissions This endpoint requires the Manage Bookings permissions scope

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PatchUpdate Schedule

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updates a schedule. This method supports patch semantics. The field values you specify replace the existing values. Fields that you don’t specify in the request remain unchanged. Array fields, if specified, overwrite the existing arrays, and therefore discards any previous array elements. The availability.locations array cannot be updated. Please use the setAvailabilityLocations endpoint instead.

Permissions This endpoint requires the Manage Bookings permissions scope

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PostCancel Schedule

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Cancels a schedule. Equivalent to batch cancel of sessions linked to a single schedule. The schedule changes to status = CANCELED - all sessions up until the time of cancellation are kept, and all future sessions are removed.

Permissions This endpoint requires the Manage Bookings permissions scope

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

GetGet Schedule

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

ets a schedule from the calendar.

Permissions This endpoint requires the Read Bookings Calendar or the Manage Bookings permissions scope. With the Read Bookings Calendar permission scope, the schedule participants are not returned.

Was this helpful?
Yes
No

PostCreate Session

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PatchUpdate Session

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updates a session.

The property values specified replace the existing values. If a property is not specified in the request it will remain unchanged. Array properties, if specified, overwrite the existing array and all of its elements. The participants array cannot be updated. Use the participantNotification property to send an email to the participants notifying them of the change.

Permissions This endpoint requires the Manage Bookings permissions scope

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PostDelete Session

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Deletes a session from a schedule.

Use the participantNotification property to send an email to the participants when the session is deleted.

When deleting a session of type "EVENT" where a booking exists, the booking's status is updated to "CANCELED".

To delete a set of recurring sessions, specify the session's recurringSessionId in the sessionId property of the request parameters.

Permissions This endpoint requires the Manage Bookings permissions scope

@snippet [deleteSession.es6=Delete a session.]

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

GetGet Session

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Returns a session from the calendar.

Permissions This endpoint requires the Read Bookings Calendar or the Manage Bookings permission scope. With the Read Bookings Calendar permission scope, the session participants are not returned.

Was this helpful?
Yes
No

PostList Sessions

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Returns multiple sessions from the calendar.

Permissions This endpoint requires the Read Bookings Calendar or the Manage Bookings permission scope With the Read Bookings Calendar permission scope, the sessions return without participants.

Was this helpful?
Yes
No

Schedule Notification

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
preserveFutureSessionsWithParticipantsboolean

notifyParticipantsboolean
Whether to notify participants about changed sessions. deprecated, use participant_notification

sitePropertiesobject
site properties. Optional. Given in create schedule notification.

instanceIdstring

ONE OF:


scheduleCreatedobject

scheduleUpdatedobject

scheduleCancelledobject

sessionCreatedobject

sessionUpdatedobject

sessionCancelledobject

availabilityPolicyUpdatedobject

intervalSplitobject

recurringSessionSplitobject

scheduleUnassignedFromUserobject
Inspect schedule.scheduleOwnerUserId on scheduleUpdated instead.

multipleSessionsCreatedobject
supported only for schedule migration apis.

migrationEventobject
supported only for schedule migration apis.
Was this helpful?
Yes
No