POST

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

If you want the schedule's events to appear in the Bookings calendar, you must set appId to the ID of the Wix Bookings app by providing {"appId": "13d21c63-b5ec-5912-8397-c3a5ddb27a97"}.

Authentication

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

Permissions
Manage Bookings - all permissions
Manage Bookings
Manage Calendars
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/calendar/v3/schedules

Body Params
scheduleScheduleRequired

Schedule to create.


idempotencyKeystringformat GUID

Idempotency key guaranteeing that you don't create the same schedule more than once.

Response Object
scheduleSchedule

Created schedule.

Creates a schedule with basic name and App ID info.

Request
cURL
curl -X POST \ 'https://www.wixapis.com/calendar/v3/schedules' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>' \ -d '{ "schedule": { "name": "Consulting 101", "appId": "27ef4db2-6609-4629-905d-3ec39e9d90e0" } }'
Response
JSON
{ "schedule": { "id": "3040aefd-73c8-4e0e-9be1-2fb80a822f13", "name": "Consulting 101", "status": "ACTIVE", "timeZone": "Europe/Dublin", "businessTimeZoneEnabled": true, "appId": "27ef4db2-6609-4629-905d-3ec39e9d90e0", "permissions": [], "revision": "1", "createdDate": "2024-10-13T12:14:12.790Z", "updatedDate": "2024-10-13T12:14:12.790Z" } }
Errors

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

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