POST
/
v2
/
bookings

Headers

cal-api-version
string
required

Must be set to 2024-08-13

Body

application/json
attendee
object
required

The attendee's details.

eventTypeId
number
required

The ID of the event type that is booked.

start
string
required

The start time of the booking in ISO 8601 format in UTC timezone.

bookingFieldsResponses
object

Booking field responses consisting of an object with booking field slug as keys and user response as values.

guests
string[]

An optional list of guest emails attending the event.

lengthInMinutes
number

If it is an event type that has multiple possible lengths that attendee can pick from, you can pass the desired booking length here. If not provided then event type default length will be used for the booking.

location
string

Location for this booking. Displayed in email and calendar event.

meetingUrl
string
deprecated

Deprecated - use 'location' instead. Meeting URL just for this booking. Displayed in email and calendar event. If not provided then cal video link will be generated.

metadata
object

You can store any additional data you want here. Metadata must have at most 50 keys, each key up to 40 characters, and string values up to 500 characters.

Response

201 - application/json
data
required

Booking data, which can be either a BookingOutput object or an array of RecurringBookingOutput objects

status
enum<string>
required
Available options:
success,
error