This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Creates an event.
If you provide recurrenceRule
, an event with {"recurrenceType": "MASTER"}
is
created. Then, you can't set start.localDate
to a past date, though the time can be
earlier on the same day. You can, however, create single-occurrence events for
past dates.
You can't create an event with recurrenceType
set to INSTANCE
or EXCEPTION
.
INSTANCE
events are generated automatically based on the recurrence rule in the
relevant MASTER
event. EXCEPTION
events are automatically created when you
update
an INSTANCE
event, which changes its recurrenceType
to EXCEPTION
.
You can only call this method when authenticated as a Wix app or Wix user identity.
Event to create.
Time zone in IANA tz database format
for calculating adjustedStart
and adjustedEnd
. For example,
America/New_York
or UTC
.
Default: timeZone
specified in the business site properties.
Idempotency key guaranteeing that you don't create the same event more than once.
Created event.
Creates an event with basic title and time.
curl -X POST \
'https://www.wixapis.com/calendar/v3/events' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH>' \
-d '{
"event": {
"scheduleId": "10d021eb-f94c-4a12-97b4-26701423a828",
"title": "Consulting Appointment",
"start": {
"localDate": "2024-10-10T12:00:00"
},
"end": {
"localDate": "2024-10-10T13:00:00"
}
}
}'
{
"event": {
"id": "9f78be4d-7b29-4201-89ef-cea0b4c79e6d",
"scheduleId": "10d021eb-f94c-4a12-97b4-26701423a828",
"externalScheduleId": "2019cd8c-9687-4bd3-95ba-e274579c0441",
"scheduleName": "Consulting Schedule",
"type": "DEFAULT",
"status": "CONFIRMED",
"start": {
"localDate": "2024-10-10T12:00:00",
"timeZone": "Europe/Dublin",
"utcDate": "2024-10-10T11:00:00Z"
},
"end": {
"localDate": "2024-10-10T13:00:00",
"timeZone": "Europe/Dublin",
"utcDate": "2024-10-10T12:00:00Z"
},
"adjustedStart": {
"localDate": "2024-10-10T12:00:00",
"timeZone": "Europe/Dublin"
},
"adjustedEnd": {
"localDate": "2024-10-10T13:00:00",
"timeZone": "Europe/Dublin"
},
"timeZone": "Europe/Dublin",
"recurrenceType": "NONE",
"transparency": "OPAQUE",
"resources": [],
"inheritedFields": ["CAPACITY", "LOCATION", "CONFERENCING_DETAILS"],
"permissions": [],
"revision": "1",
"createdDate": "2024-10-07T07:29:32.993Z",
"updatedDate": "2024-10-07T07:29:32.993Z"
}
}
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.