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.


timeSlotTimeSlot

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

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.

Did this help?

GET

List Schedule Items


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

Endpoint
GET
https://www.wixapis.com/events/v1/schedule

Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

POST

Query 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

Errors
400Invalid Argument

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?

GET

Get Schedule Item


Retrieves schedule item by ID.

Endpoint
GET
https://www.wixapis.com/events/v1/schedule/{itemId}

Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

POST

Add Schedule Item


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

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Events - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/events/v1/schedule/draft

Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

DELETE

Discard Draft


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

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Events - all permissions
Learn more about app permissions.
Endpoint
DELETE
https://www.wixapis.com/events/v1/schedule/draft

Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

PATCH

Update Schedule Item


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

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Events - all permissions
Learn more about app permissions.
Endpoint
PATCH
https://www.wixapis.com/events/v1/schedule/draft/{itemId}

Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

DELETE

Delete Schedule Item


Deletes schedule item from draft schedule.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Events - all permissions
Learn more about app permissions.
Endpoint
DELETE
https://www.wixapis.com/events/v1/schedule/draft/items

Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

POST

Publish Draft


Publishes the draft schedule.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Events - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/events/v1/schedule/publish

Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

POST

Reschedule Draft


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

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Events - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/events/v1/schedule/draft/reschedule

Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

GET

List Bookmarks


Retrieves a list of bookmarked schedule items for current member.

Endpoint
GET
https://www.wixapis.com/events/v1/schedule/bookmarks

Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

POST

Create Bookmark


Bookmarks schedule item for current member.

Endpoint
POST
https://www.wixapis.com/events/v1/schedule/{itemId}/bookmark

Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

DELETE

Delete Bookmark


Removes schedule item bookmark from current member.

Endpoint
DELETE
https://www.wixapis.com/events/v1/schedule/{itemId}/bookmark

Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?