Create an event type

POST

event-types

Headers

cal-api-version

string

required

Must be set to 2024-06-14

Authorization

string

required

value must be Bearer <token> where <token> either managed user access token or api key prefixed with cal_

Body

application/json

lengthInMinutes

number

required

lengthInMinutesOptions

string[]

required

If you want that user can choose between different lengths of the event you can specify them here. Must include the provided lengthInMinutes.

slug

string

required

title

string

required

afterEventBuffer

number

Time spaces that can be appended after an event to give more time after it.

beforeEventBuffer

number

Time spaces that can be pre-pended before an event to give more time before it.

bookerLayouts

object

Should booker have week, month or column view. Specify default layout and enabled layouts user can pick.

bookingFields

object[]

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.

bookingLimitsCount

object

Limit how many times this event can be booked

bookingLimitsDuration

object

Limit total amount of time that this event can be booked

bookingWindow

object

Limit how far in the future this event can be booked

bookingWindow.type

enum<string>

required

Whether the window should be business days, calendar days or a range of dates

Available options:

businessDays,

calendarDays,

range

bookingWindow.value

number

required

How many business day into the future can this event be booked

bookingWindow.rolling

boolean

  Determines the behavior of the booking window:
  - If **true**, the window is rolling. This means the number of available days will always be equal the specified 'value' 
    and adjust dynamically as bookings are made. For example, if 'value' is 3 and availability is only on Mondays, 
    a booker attempting to schedule on November 10 will see slots on November 11, 18, and 25. As one of these days 
    becomes fully booked, a new day (e.g., December 2) will open up to ensure 3 available days are always visible.
  - If **false**, the window is fixed. This means the booking window only considers the next 'value' days from the
    moment someone is trying to book. For example, if 'value' is 3, availability is only on Mondays, and the current 
    date is November 10, the booker will only see slots on November 11 because the window is restricted to the next 
    3 calendar days (November 10–12).

color

object

confirmationPolicy

object

Specify how the booking needs to be manually confirmed before it is pushed to the integrations and a confirmation mail is sent.

customName

string

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}

description

string

destinationCalendar

object

disableGuests

boolean

If true, person booking this event't cant add guests via their emails.

hideCalendarEventDetails

boolean

hideCalendarNotes

boolean

locations

object[]

Locations where the event will take place. If not provided, cal video link will be used as the location.

lockTimeZoneToggleOnBookingPage

boolean

minimumBookingNotice

number

Minimum number of minutes before the event that a booking can be made.

offsetStart

number

Offset timeslots shown to bookers by a specified number of minutes

onlyShowFirstAvailableSlot

boolean

This will limit your availability for this event type to one slot per day, scheduled at the earliest available time.

recurrence

object

Create a recurring event type.

requiresBookerEmailVerification

boolean

scheduleId

number

If you want that this event has different schedule than user's default one you can specify it here.

seats

object

Create an event type with multiple seats.

slotInterval

number

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.

successRedirectUrl

string

A valid URL where the booker will redirect to, once the booking is completed successfully

useDestinationCalendarEmail

boolean

Response

201 - application/json

data

object

required

data.bookingFields

object[]

required

data.currency

string

required

data.description

string

required

data.disableGuests

boolean

required

data.forwardParamsSuccessRedirect

object | null

required

data.id

number

required

data.isInstantEvent

boolean

required

data.lengthInMinutes

number

required

data.locations

object[]

required

data.lockTimeZoneToggleOnBookingPage

boolean

required

data.metadata

object

required

data.ownerId

number

required

data.price

number

required

data.recurrence

object

required

data.scheduleId

number | null

required

data.slug

string

required

data.successRedirectUrl

object | null

required

data.title

string

required

data.users

string[]

required

data.afterEventBuffer

number

data.beforeEventBuffer

number

data.bookerLayouts

object

data.bookingLimitsCount

object

data.bookingLimitsDuration

object

data.bookingWindow

object[]

Limit how far in the future this event can be booked

data.bookingWindow.type

enum<string>

required

Whether the window should be business days, calendar days or a range of dates

Available options:

businessDays,

calendarDays,

range

data.bookingWindow.value

number

required

How many business day into the future can this event be booked

data.bookingWindow.rolling

boolean

  Determines the behavior of the booking window:
  - If **true**, the window is rolling. This means the number of available days will always be equal the specified 'value' 
    and adjust dynamically as bookings are made. For example, if 'value' is 3 and availability is only on Mondays, 
    a booker attempting to schedule on November 10 will see slots on November 11, 18, and 25. As one of these days 
    becomes fully booked, a new day (e.g., December 2) will open up to ensure 3 available days are always visible.
  - If **false**, the window is fixed. This means the booking window only considers the next 'value' days from the
    moment someone is trying to book. For example, if 'value' is 3, availability is only on Mondays, and the current 
    date is November 10, the booker will only see slots on November 11 because the window is restricted to the next 
    3 calendar days (November 10–12).

data.color

object

data.confirmationPolicy

object

data.customName

string

data.destinationCalendar

object

data.hideCalendarEventDetails

boolean

data.hideCalendarNotes

boolean

data.lengthInMinutesOptions

number[]

If you want that user can choose between different lengths of the event you can specify them here. Must include the provided lengthInMinutes.

data.minimumBookingNotice

number

data.offsetStart

number

data.onlyShowFirstAvailableSlot

boolean

data.requiresBookerEmailVerification

boolean

data.seats

object

data.seatsPerTimeSlot

object | null

data.seatsShowAvailabilityCount

boolean | null

data.slotInterval

object | null

data.useDestinationCalendarEmail

boolean

status

enum<string>

required

Available options:

success,

error

Was this page helpful?

Suggest edits Raise issue

Get all event types Get an event type

Getting Started

Platform / Cal Provider

Platform / Google Calendar

Platform / Managed Users

Platform / Webhooks

Orgs / Attributes

Orgs / Attributes / Options

Orgs / Event Types

Orgs / Memberships

Orgs / Schedules

Orgs / Teams

Orgs / Teams / Memberships

Orgs / Teams / Schedules

Orgs / Users

Orgs / Users / OOO

Orgs / Webhooks

Bookings

Calendars

Conferencing

Destination Calendars

Event Types

Event Types / Webhooks

Me

Schedules

Selected Calendars

Slots

Stripe

Teams

Teams / Event Types

Teams / Memberships

Timezones

Webhooks

Headers

Body

Response