Search.../
  1. Home
  2. Getting Started
  3. Overview
Generate a test token to explore our APIs

Create Schedule

Developer Preview

Creates a schedule.

Permissions
This endpoint requires the Manage Bookings permissions scope

Authorization

This endpoint requires an authorization header - pass the access token from the OAuth installation flow.

POST

https://www.wixapis.com/bookings/v1/calendar/schedules

Body Params

NAME
TYPE
DESCRIPTION
schedule
Required

object

Schedule.

Response Object

NAME
TYPE
DESCRIPTION
schedule

object

Schedule.

errors
Deprecated

Array<object>

Status/Error Codes

The response will include an HTTP status code.

Was this helpful?

Create recurring sessions schedule.

Create a schedule with recurring intervals.

Request

curl

Copy Code
1curl -X POST \
2 'https://www.wixapis.com/bookings/v1/calendar/schedules' \
3 -H "Content-Type: application/json" \
4 -H 'Authorization: <AUTH>' \
5 --data '{
6 "schedule": {
7 "scheduleOwnerId": "3d7dba43-d214-4149-8a53-a1a4a0c1e636",
8 "intervals": [
9 {
10 "start": "2020-04-28T21:00:00Z",
11 "end": "2021-04-29T21:00:00.000Z",
12 "interval": {
13 "daysOfWeek": "THU",
14 "hourOfDay": 10,
15 "minuteOfHour": 0,
16 "duration": 180
17 },
18 "frequency": {
19 "repetition": 1
20 },
21 "affectedSchedules": [
22 {
23 "scheduleId": "e07c6328-4495-4b80-b04d-c45f13215881",
24 "transparency": "BUSY"
25 }
26 ]
27 }
28 ],
29 "title": "Intermediate Ski Class",
30 "tags": [
31 "GROUP"
32 ],
33 "location": {
34 "locationType": "OWNER_BUSINESS"
35 },
36 "capacity": 50,
37 "rate": {
38 "labeledPriceOptions": {
39 "general": {
40 "amount": "180",
41 "currency": "USD",
42 "downPayAmount": "0"
43 }
44 }
45 }
46 }
47 }'

Response

json

1
2{"schedule": {
3 "id": "ef17e614-f318-41f4-9fc4-e6baa562f7e7",
4 "scheduleOwnerId": "3d7dba43-d214-4149-8a53-a1a4a0c1e636",
5 "firstSessionStart": "2020-04-30T14:00:00Z",
6 "lastSessionEnd": "2021-04-29T17:00:00Z",
7 "timeZone": "America/Denver",
8 "intervals": [ {
9 "id": "4b8d0a0e-6e4e-4557-8377-f1209f759eb3",
10 "start": "2020-04-28T21:00:00Z",
11 "end": "2021-04-29T21:00:00.000Z",
12 "interval": {
13 "daysOfWeek": "THU",
14 "hourOfDay": 10,
15 "minuteOfHour": 0,
16 "duration": 180
17 },
18 "frequency": {"repetition": 1},
19 "affectedSchedules": [ {
20 "scheduleId": "e07c6328-4495-4b80-b04d-c45f13215881",
21 "transparency": "BUSY",
22 "scheduleOwnerId": "76570209-101f-409b-af97-b445bdb63125"
23 }]
24 }],
25 "title": "Intermediate Ski Class",
26 "tags": ["GROUP"],
27 "location": {"locationType": "OWNER_BUSINESS"},
28 "capacity": 50,
29 "rate": {"labeledPriceOptions": {"general": {
30 "amount": "180",
31 "currency": "USD",
32 "downPayAmount": "0"
33 }}},
34 "totalNumberOfParticipants": 0,
35 "participants": [],
36 "status": "CREATED",
37 "created": "2020-04-29T19:24:21.830Z",
38 "updated": "2020-04-29T19:24:21.830Z",
39 "version": 0,
40 "inheritedFields": ["timeZone"]
41}}
Create an availability based schedule.
Create an availability based schedule.