Schedule Item Object

Schedule item describes the schedule within an event. Each event may contain multiple schedule items.

Properties
idstringRead-onlyformat GUID
Schedule item ID.
hiddenboolean
Whether schedule item is hidden from guests.
namestringmaxLength 120
Schedule item name.
timeSlotobject
Time slot of an schedule item.
descriptionstringmaxLength 10000
Rich-text content displayed in Wix UI when viewing schedule item details (HTML).
stageNamestringmaxLength 30
Stage or room name in which session takes place.
tagsArray <string>maxItems 5minLength 1maxLength 30
Tags are used to organize schedule items by assigning them to a general theme or field of study.
statusstring
2 enum supported values:
SCHEDULEDCANCELED
Schedule item status.
createdDatestringRead-onlyformat date-time
Schedule item created timestamp.
updatedDatestringRead-onlyformat date-time
Schedule item modified timestamp.
eventIdstringRead-onlyformat GUID
Event ID.
draftbooleanRead-only
Whether schedule item is draft.
Was this helpful?
Yes
No
GetList Schedule Items

Retrieves a list of up to 100 schedule items, with basic filter support.

Endpoint
GET
https://www.wixapis.com/events/v1/schedule
Was this helpful?
Yes
No
PostQuery Schedule Items

Retrieves a list of up to 100 schedule items, given the provided paging, filtering.

  • Important **:
  • All results are for one specific business, resolved from the request context.

Query object support:

Defaults:

  • When filter is not specified, returns all schedule items that caller is authorized to read.
  • When sorting is not specified, defaults to time_slot.start and time_slot.end in ASC order.
Endpoint
POST
https://www.wixapis.com/events/v1/schedule/query
Was this helpful?
Yes
No
GetGet Schedule Item

Retrieves schedule item by ID.

Endpoint
GET
https://www.wixapis.com/events/v1/schedule/{itemId}
Was this helpful?
Yes
No
PostAdd Schedule Item

Adds schedule item to the draft schedule. Draft items are not publicly available unless published.

Endpoint
POST
https://www.wixapis.com/events/v1/schedule/draft
Was this helpful?
Yes
No
DeleteDiscard Draft

Clears all changes to the draft schedule. (Does not affect the published schedule.)

Endpoint
DELETE
https://www.wixapis.com/events/v1/schedule/draft
Was this helpful?
Yes
No
PatchUpdate Schedule Item

Updates existing schedule item. All modifications are performed on a draft schedule, even if schedule item has already been published.

Endpoint
PATCH
https://www.wixapis.com/events/v1/schedule/draft/{itemId}
Was this helpful?
Yes
No
DeleteDelete Schedule Item

Deletes schedule item from draft schedule.

Endpoint
DELETE
https://www.wixapis.com/events/v1/schedule/draft/items
Was this helpful?
Yes
No
PostPublish Draft

Publishes the draft schedule.

Endpoint
POST
https://www.wixapis.com/events/v1/schedule/publish
Was this helpful?
Yes
No
PostReschedule Draft

Adjusts time of all draft schedule items (per event).

Endpoint
POST
https://www.wixapis.com/events/v1/schedule/draft/reschedule
Was this helpful?
Yes
No
GetList Bookmarks

Retrieves a list of bookmarked schedule items for current member.

Endpoint
GET
https://www.wixapis.com/events/v1/schedule/bookmarks
Was this helpful?
Yes
No
PostCreate Bookmark

Bookmarks schedule item for current member.

Endpoint
POST
https://www.wixapis.com/events/v1/schedule/{itemId}/bookmark
Was this helpful?
Yes
No