POST

Create Session


Deprecated

This method has been replaced with CreateEvent, and will be removed on June 30, 2025.

Creates a session. A session is an occupied period of time on a schedule or period of availability on a resource's schedule.

Session may be individual sessions or recurring sessions. An individual session has a discrete start and end date. A recurring session defines a series of repeating sessions. The recurrence is defined using a subset of RRULEs.

Session can be owned by resources or services. Set type to "WORING_HOURS" when creating sessions for resource availability. Set type to "EVENT" when creating sessions owned by a service's schedule,

The session start and end properties set the time and duration of the session. For non-recurring sessions, timestamp or localDateTime properties can be used. For recurring sessions, use the localDateTime property only. For recurring sessions, the start property sets the date and time of the first recurring session, subject to the recurrence rule. The year, monthOfYear and dayOfMonth properties in the end property are used with the hourOfDay and minutesOfHour properties to set the duration of the session relative to the start. The UNTIL keyword in the recurrence property sets the date for the last recurring session.

You can create a session that blocks hours on the resource's calendar making the resource unavailable. Create a either recurring or non-recurring sessions of type "EVENT", and add "Blocked" to the tags array.

For recurring availability sessions, the following properties must be populated:

  • scheduleId
  • start
  • end
  • type
  • recurrence

Permissions This endpoint requires the Manage Bookings permissions scope

Endpoint
POST
https://www.wixapis.com/bookings/v1/calendar/sessions

Event TriggersThis method triggers the following events:
Did this help?