Create a booking

POST /v2/bookings is used to create regular bookings, recurring bookings and instant bookings. The request bodies for all 3 are almost the same except: If eventTypeId in the request body is id of a regular event, then regular booking is created.

If it is an id of a recurring event type, then recurring booking is created.

Meaning that the request bodies are equal but the outcome depends on what kind of event type it is with the goal of making it as seamless for developers as possible.

For team event types it is possible to create instant meeting. To do that just pass "instant": true to the request body.

The start needs to be in UTC aka if the timezone is GMT+2 in Rome and meeting should start at 11, then UTC time should have hours 09:00 aka without time zone.

Finally, there are 2 ways to book an event type belonging to an individual user:

1. Provide eventTypeId in the request body.
2. Provide eventTypeSlug and username and optionally organizationSlug if the user with the username is within an organization.

And 2 ways to book and event type belonging to a team:

1. Provide eventTypeId in the request body.
2. Provide eventTypeSlug and teamSlug and optionally organizationSlug if the team with the teamSlug is within an organization.

Headers

cal-api-version

string

default:2024-08-13

required

Must be set to 2024-08-13

Body

application/json

Accepts different types of booking input: Create Booking (Option 1), Create Instant Booking (Option 2), or Create Recurring Booking (Option 3)

• Option 1
• Option 2
• Option 3

start

string

required

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

Example:

"2024-08-13T09:00:00Z"

attendee

object

required

The attendee's details.

Show child attributes

attendee.name

string

required

The name of the attendee.

Example:

"John Doe"

attendee.timeZone

string

required

The time zone of the attendee.

Example:

"America/New_York"

attendee.email

string

The email of the attendee.

Example:

"[e-mail]"

attendee.phoneNumber

string

The phone number of the attendee in international format.

Example:

"[phone]"

attendee.language

enum<string>

default:en

The preferred language of the attendee. Used for booking confirmation.

Available options:

ar,

ca,

de,

es,

eu,

he,

id,

ja,

lv,

pl,

ro,

sr,

th,

vi,

az,

cs,

el,

es-419,

fi,

hr,

it,

km,

nl,

pt,

ru,

sv,

tr,

zh-CN,

bg,

da,

en,

et,

fr,

hu,

iw,

ko,

no,

pt-BR,

sk,

ta,

uk,

zh-TW

Example:

"it"

bookingFieldsResponses

object

Booking field responses consisting of an object with booking field slug as keys and user response as values for custom booking fields added by you.

Example:

{ "customField": "customValue" }

eventTypeId

number

The ID of the event type that is booked. Required unless eventTypeSlug and username are provided as an alternative to identifying the event type.

Example:

123

eventTypeSlug

string

The slug of the event type. Required along with username / teamSlug and optionally organizationSlug if eventTypeId is not provided.

Example:

"my-event-type"

username

string

The username of the event owner. Required along with eventTypeSlug and optionally organizationSlug if eventTypeId is not provided.

Example:

"john-doe"

teamSlug

string

Team slug for team that owns event type for which slots are fetched. Required along with eventTypeSlug and optionally organizationSlug if the team is part of organization

Example:

"john-doe"

organizationSlug

string

The organization slug. Optional, only used when booking with eventTypeSlug + username or eventTypeSlug + teamSlug.

Example:

"acme-corp"

guests

string[]

An optional list of guest emails attending the event.

Example:

["[e-mail]", "[e-mail]"]

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.

Example:

"https://example.com/meeting"

location

object

One of the event type locations. If instead of passing one of the location objects as required by schema you are still passing a string please use an object.

• Option 1
• Option 2
• Option 3
• Option 4
• Option 5
• Option 6
• Option 7
• Option 8

Show child attributes

location.type

string

required

only allowed value for type is address - it refers to address defined by the organizer.

Example:

"address"

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.

Example:

{ "key": "value" }

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.

Example:

30

start

string

required

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

Example:

"2024-08-13T09:00:00Z"

attendee

object

required

The attendee's details.

Show child attributes

attendee.name

string

required

The name of the attendee.

Example:

"John Doe"

attendee.timeZone

string

required

The time zone of the attendee.

Example:

"America/New_York"

attendee.email

string

The email of the attendee.

Example:

"[e-mail]"

attendee.phoneNumber

string

The phone number of the attendee in international format.

Example:

"[phone]"

attendee.language

enum<string>

default:en

The preferred language of the attendee. Used for booking confirmation.

Available options:

ar,

ca,

de,

es,

eu,

he,

id,

ja,

lv,

pl,

ro,

sr,

th,

vi,

az,

cs,

el,

es-419,

fi,

hr,

it,

km,

nl,

pt,

ru,

sv,

tr,

zh-CN,

bg,

da,

en,

et,

fr,

hu,

iw,

ko,

no,

pt-BR,

sk,

ta,

uk,

zh-TW

Example:

"it"

bookingFieldsResponses

object

Booking field responses consisting of an object with booking field slug as keys and user response as values for custom booking fields added by you.

Example:

{ "customField": "customValue" }

eventTypeId

number

The ID of the event type that is booked. Required unless eventTypeSlug and username are provided as an alternative to identifying the event type.

Example:

123

eventTypeSlug

string

The slug of the event type. Required along with username / teamSlug and optionally organizationSlug if eventTypeId is not provided.

Example:

"my-event-type"

username

string

The username of the event owner. Required along with eventTypeSlug and optionally organizationSlug if eventTypeId is not provided.

Example:

"john-doe"

teamSlug

string

Team slug for team that owns event type for which slots are fetched. Required along with eventTypeSlug and optionally organizationSlug if the team is part of organization

Example:

"john-doe"

organizationSlug

string

The organization slug. Optional, only used when booking with eventTypeSlug + username or eventTypeSlug + teamSlug.

Example:

"acme-corp"

guests

string[]

An optional list of guest emails attending the event.

Example:

["[e-mail]", "[e-mail]"]

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.

Example:

"https://example.com/meeting"

location

object

One of the event type locations. If instead of passing one of the location objects as required by schema you are still passing a string please use an object.

• Option 1
• Option 2
• Option 3
• Option 4
• Option 5
• Option 6
• Option 7
• Option 8

Show child attributes

location.type

string

required

only allowed value for type is address - it refers to address defined by the organizer.

Example:

"address"

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.

Example:

{ "key": "value" }

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.

Example:

30

start

string

required

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

Example:

"2024-08-13T09:00:00Z"

attendee

object

required

The attendee's details.

Show child attributes

attendee.name

string

required

The name of the attendee.

Example:

"John Doe"

attendee.timeZone

string

required

The time zone of the attendee.

Example:

"America/New_York"

attendee.email

string

The email of the attendee.

Example:

"[e-mail]"

attendee.phoneNumber

string

The phone number of the attendee in international format.

Example:

"[phone]"

attendee.language

enum<string>

default:en

The preferred language of the attendee. Used for booking confirmation.

Available options:

ar,

ca,

de,

es,

eu,

he,

id,

ja,

lv,

pl,

ro,

sr,

th,

vi,

az,

cs,

el,

es-419,

fi,

hr,

it,

km,

nl,

pt,

ru,

sv,

tr,

zh-CN,

bg,

da,

en,

et,

fr,

hu,

iw,

ko,

no,

pt-BR,

sk,

ta,

uk,

zh-TW

Example:

"it"

instant

boolean

required

Flag indicating if the booking is an instant booking. Only available for team events.

Example:

true

bookingFieldsResponses

object

Booking field responses consisting of an object with booking field slug as keys and user response as values for custom booking fields added by you.

Example:

{ "customField": "customValue" }

eventTypeId

number

The ID of the event type that is booked. Required unless eventTypeSlug and username are provided as an alternative to identifying the event type.

Example:

123

eventTypeSlug

string

The slug of the event type. Required along with username / teamSlug and optionally organizationSlug if eventTypeId is not provided.

Example:

"my-event-type"

username

string

The username of the event owner. Required along with eventTypeSlug and optionally organizationSlug if eventTypeId is not provided.

Example:

"john-doe"

teamSlug

string

Team slug for team that owns event type for which slots are fetched. Required along with eventTypeSlug and optionally organizationSlug if the team is part of organization

Example:

"john-doe"

organizationSlug

string

The organization slug. Optional, only used when booking with eventTypeSlug + username or eventTypeSlug + teamSlug.

Example:

"acme-corp"

guests

string[]

An optional list of guest emails attending the event.

Example:

["[e-mail]", "[e-mail]"]

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.

Example:

"https://example.com/meeting"

location

object

One of the event type locations. If instead of passing one of the location objects as required by schema you are still passing a string please use an object.

• Option 1
• Option 2
• Option 3
• Option 4
• Option 5
• Option 6
• Option 7
• Option 8

Show child attributes

location.type

string

required

only allowed value for type is address - it refers to address defined by the organizer.

Example:

"address"

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.

Example:

{ "key": "value" }

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.

Example:

30

start

string

required

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

Example:

"2024-08-13T09:00:00Z"

attendee

object

required

The attendee's details.

Show child attributes

attendee.name

string

required

The name of the attendee.

Example:

"John Doe"

attendee.timeZone

string

required

The time zone of the attendee.

Example:

"America/New_York"

attendee.email

string

The email of the attendee.

Example:

"[e-mail]"

attendee.phoneNumber

string

The phone number of the attendee in international format.

Example:

"[phone]"

attendee.language

enum<string>

default:en

The preferred language of the attendee. Used for booking confirmation.

Available options:

ar,

ca,

de,

es,

eu,

he,

id,

ja,

lv,

pl,

ro,

sr,

th,

vi,

az,

cs,

el,

es-419,

fi,

hr,

it,

km,

nl,

pt,

ru,

sv,

tr,

zh-CN,

bg,

da,

en,

et,

fr,

hu,

iw,

ko,

no,

pt-BR,

sk,

ta,

uk,

zh-TW

Example:

"it"

bookingFieldsResponses

object

Booking field responses consisting of an object with booking field slug as keys and user response as values for custom booking fields added by you.

Example:

{ "customField": "customValue" }

eventTypeId

number

The ID of the event type that is booked. Required unless eventTypeSlug and username are provided as an alternative to identifying the event type.

Example:

123

eventTypeSlug

string

The slug of the event type. Required along with username / teamSlug and optionally organizationSlug if eventTypeId is not provided.

Example:

"my-event-type"

username

string

The username of the event owner. Required along with eventTypeSlug and optionally organizationSlug if eventTypeId is not provided.

Example:

"john-doe"

teamSlug

string

Team slug for team that owns event type for which slots are fetched. Required along with eventTypeSlug and optionally organizationSlug if the team is part of organization

Example:

"john-doe"

organizationSlug

string

The organization slug. Optional, only used when booking with eventTypeSlug + username or eventTypeSlug + teamSlug.

Example:

"acme-corp"

guests

string[]

An optional list of guest emails attending the event.

Example:

["[e-mail]", "[e-mail]"]

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.

Example:

"https://example.com/meeting"

location

object

One of the event type locations. If instead of passing one of the location objects as required by schema you are still passing a string please use an object.

• Option 1
• Option 2
• Option 3
• Option 4
• Option 5
• Option 6
• Option 7
• Option 8

Show child attributes

location.type

string

required

only allowed value for type is address - it refers to address defined by the organizer.

Example:

"address"

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.

Example:

{ "key": "value" }

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.

Example:

30

recurrenceCount

number

The number of recurrences. If not provided then event type recurrence count will be used. Can't be more than event type recurrence count

Example:

5

Response

201 - application/json

status

enum<string>

required

Available options:

success,

error

Example:

"success"

data

required

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

Show child attributes

data.id

number

required

Example:

123

data.uid

string

required

Example:

"booking_uid_123"

data.title

string

required

Example:

"Consultation"

data.description

string

required

Example:

"Learn how to integrate scheduling into marketplace."

data.hosts

object[]

required

Show child attributes

data.hosts.id

number

required

Example:

1

data.hosts.name

string

required

Example:

"Jane Doe"

data.hosts.email

string

required

Example:

"[e-mail]"

data.hosts.username

string

required

Example:

"jane100"

data.hosts.timeZone

string

required

Example:

"America/Los_Angeles"

data.status

enum<string>

required

Available options:

cancelled,

accepted,

rejected,

pending

Example:

"accepted"

data.start

string

required

Example:

"2024-08-13T15:30:00Z"

data.end

string

required

Example:

"2024-08-13T16:30:00Z"

data.duration

number

required

Example:

60

data.eventTypeId

number

required

deprecated

Deprecated - rely on 'eventType' object containing the id instead.

Example:

50

data.eventType

object

required

Show child attributes

data.eventType.id

number

required

Example:

1

data.eventType.slug

string

required

Example:

"some-event"

data.location

string

required

Example:

"https://example.com/meeting"

data.absentHost

boolean

required

Example:

true

data.createdAt

string

required

Example:

"2024-08-13T15:30:00Z"

data.updatedAt

string

required

Example:

"2024-08-13T15:30:00Z"

data.attendees

object[]

required

Show child attributes

data.attendees.name

string

required

The name of the attendee.

Example:

"John Doe"

data.attendees.timeZone

string

required

The time zone of the attendee.

Example:

"America/New_York"

data.attendees.email

string

The email of the attendee.

Example:

"[e-mail]"

data.attendees.phoneNumber

string

The phone number of the attendee in international format.

Example:

"[phone]"

data.attendees.language

enum<string>

default:en

The preferred language of the attendee. Used for booking confirmation.

Available options:

ar,

ca,

de,

es,

eu,

he,

id,

ja,

lv,

pl,

ro,

sr,

th,

vi,

az,

cs,

el,

es-419,

fi,

hr,

it,

km,

nl,

pt,

ru,

sv,

tr,

zh-CN,

bg,

da,

en,

et,

fr,

hu,

iw,

ko,

no,

pt-BR,

sk,

ta,

uk,

zh-TW

Example:

"it"

data.bookingFieldsResponses

object

required

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

Example:

{ "customField": "customValue" }

data.cancellationReason

string

Example:

"User requested cancellation"

data.cancelledByEmail

string

Example:

"[e-mail]"

data.reschedulingReason

string

Example:

"User rescheduled the event"

data.rescheduledByEmail

string

Example:

"[e-mail]"

data.rescheduledFromUid

string

Example:

"previous_uid_123"

data.meetingUrl

string

deprecated

Deprecated - rely on 'location' field instead.

Example:

"https://example.com/recurring-meeting"

data.metadata

object

Example:

{ "key": "value" }

data.rating

number

Example:

4

data.icsUid

string

UID of ICS event.

Example:

"ics_uid_123"

data.guests

string[]

Example:

["[e-mail]", "[e-mail]"]