Headers
For non-platform customers - value must be Bearer <token>
where <token>
is api key prefixed with cal_
For platform customers - OAuth client secret key
For platform customers - OAuth client ID
Body
60
"Learn the secrets of masterchief!"
"learn-the-secrets-of-masterchief"
The scheduling type for the team event - collective, roundRobin or managed.
collective
, roundRobin
, managed
"collective"
If you want that user can choose between different lengths of the event you can specify them here. Must include the provided lengthInMinutes
.
[15, 30, 60]
"Discover the culinary wonders of the Argentina by making the best flan ever!"
Custom fields that can be added to the booking form when the event is booked by someone. By default booking form has name and email field.
If true, person booking this event can't add guests via their emails.
Number representing length of each slot when event is booked. By default it equal length of the event type. If event length is 60 minutes then we would have slots 9AM, 10AM, 11AM etc. but if it was changed to 30 minutes then we would have slots 9AM, 9:30AM, 10AM, 10:30AM etc. as the available times to book the 60 minute event.
Minimum number of minutes before the event that a booking can be made.
Time spaces that can be prepended before an event to give more time before it.
Time spaces that can be appended after an event to give more time after it.
If you want that this event has different schedule than user's default one you can specify it here.
Limit how many times this event can be booked
This will limit your availability for this event type to one slot per day, scheduled at the earliest available time.
Limit total amount of time that this event can be booked
Limit how far in the future this event can be booked
Offset timeslots shown to bookers by a specified number of minutes
Should booker have week, month or column view. Specify default layout and enabled layouts user can pick.
Specify how the booking needs to be manually confirmed before it is pushed to the integrations and a confirmation mail is sent.
Create a recurring event type.
Create an event type with multiple seats.
Customizable event name with valid variables: {Event type title}, {Organiser}, {Scheduler}, {Location}, {Organiser first name}, {Scheduler first name}, {Scheduler last name}, {Event duration}, {LOCATION}, {HOST/ATTENDEE}, {HOST}, {ATTENDEE}, {USER}
"{Event type title} between {Organiser} and {Scheduler}"
A valid URL where the booker will redirect to, once the booking is completed successfully
"https://masterchief.com/argentina/flan/video/9129412"
Boolean to Hide organizer's email address from the booking screen, email notifications, and calendar events
Cal video settings for the event type
Boolean to require authentication for booking this event type via api. If true, only authenticated users can book this event type.
Hosts contain specific team members you want to assign to this event type, but if you want to assign all team members, use assignAllTeamMembers: true
instead and omit this field. For platform customers the hosts can include userIds only of managed users.
If true, all current and future team members will be assigned to this event type
Locations where the event will take place. If not provided, cal video link will be used as the location.