Skip to main content
POST
/
v2
/
organizations
/
{orgId}
/
teams
/
{teamId}
/
event-types
Create an event type
curl --request POST \
  --url https://api.cal.com/v2/organizations/{orgId}/teams/{teamId}/event-types \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "lengthInMinutes": 60,
  "title": "Learn the secrets of masterchief!",
  "slug": "learn-the-secrets-of-masterchief",
  "schedulingType": "collective",
  "lengthInMinutesOptions": [
    15,
    30,
    60
  ],
  "description": "Discover the culinary wonders of the Argentina by making the best flan ever!",
  "bookingFields": [
    {
      "type": "name",
      "label": "<string>",
      "placeholder": "<string>",
      "disableOnPrefill": true
    }
  ],
  "disableGuests": true,
  "slotInterval": 123,
  "minimumBookingNotice": 123,
  "beforeEventBuffer": 123,
  "afterEventBuffer": 123,
  "scheduleId": 123,
  "bookingLimitsCount": {
    "day": 1,
    "week": 2,
    "month": 3,
    "year": 4,
    "disabled": false
  },
  "bookerActiveBookingsLimit": {
    "maximumActiveBookings": 3,
    "offerReschedule": true
  },
  "onlyShowFirstAvailableSlot": true,
  "bookingLimitsDuration": {
    "day": 60,
    "week": 120,
    "month": 180,
    "year": 240
  },
  "bookingWindow": {
    "type": "businessDays",
    "value": 5,
    "rolling": true
  },
  "offsetStart": 123,
  "bookerLayouts": {
    "defaultLayout": "month",
    "enabledLayouts": [
      "month"
    ]
  },
  "confirmationPolicy": {
    "type": "always",
    "blockUnconfirmedBookingsInBooker": true,
    "noticeThreshold": {
      "unit": "minutes",
      "count": 30
    }
  },
  "recurrence": {
    "interval": 10,
    "occurrences": 10,
    "frequency": "yearly"
  },
  "requiresBookerEmailVerification": true,
  "hideCalendarNotes": true,
  "lockTimeZoneToggleOnBookingPage": true,
  "color": {
    "lightThemeHex": "#292929",
    "darkThemeHex": "#fafafa"
  },
  "seats": {
    "seatsPerTimeSlot": 4,
    "showAttendeeInfo": true,
    "showAvailabilityCount": true
  },
  "customName": "{Event type title} between {Organiser} and {Scheduler}",
  "destinationCalendar": {
    "integration": "<string>",
    "externalId": "<string>"
  },
  "useDestinationCalendarEmail": true,
  "hideCalendarEventDetails": true,
  "successRedirectUrl": "https://masterchief.com/argentina/flan/video/9129412",
  "hideOrganizerEmail": true,
  "calVideoSettings": {
    "disableRecordingForOrganizer": true,
    "disableRecordingForGuests": true,
    "redirectUrlOnExit": {},
    "enableAutomaticRecordingForOrganizer": true,
    "enableAutomaticTranscription": true,
    "disableTranscriptionForGuests": true,
    "disableTranscriptionForOrganizer": true
  },
  "hidden": true,
  "bookingRequiresAuthentication": false,
  "hosts": [
    {
      "userId": 123,
      "mandatory": true,
      "priority": "lowest"
    }
  ],
  "assignAllTeamMembers": true,
  "locations": [
    {
      "type": "address",
      "address": "123 Example St, City, Country",
      "public": true
    }
  ],
  "emailSettings": {
    "disableEmailsToAttendees": true,
    "disableEmailsToHosts": true
  },
  "rescheduleWithSameRoundRobinHost": true
}
'
{
  "status": "success",
  "data": {
    "id": 1,
    "lengthInMinutes": 60,
    "title": "Learn the secrets of masterchief!",
    "slug": "learn-the-secrets-of-masterchief",
    "description": "Discover the culinary wonders of Argentina by making the best flan ever!",
    "locations": [
      {
        "type": "address",
        "address": "123 Example St, City, Country",
        "public": true
      }
    ],
    "bookingFields": [
      {
        "type": "name",
        "label": "<string>",
        "placeholder": "<string>",
        "isDefault": true,
        "slug": "name",
        "required": true,
        "disableOnPrefill": true
      }
    ],
    "disableGuests": true,
    "recurrence": {
      "interval": 10,
      "occurrences": 10,
      "frequency": "yearly"
    },
    "metadata": {},
    "price": 123,
    "currency": "<string>",
    "lockTimeZoneToggleOnBookingPage": true,
    "forwardParamsSuccessRedirect": {},
    "successRedirectUrl": {},
    "isInstantEvent": true,
    "scheduleId": 123,
    "hidden": true,
    "bookingRequiresAuthentication": true,
    "teamId": 123,
    "hosts": [
      "<string>"
    ],
    "schedulingType": "roundRobin",
    "team": {
      "id": 123,
      "slug": "<string>",
      "bannerUrl": "<string>",
      "name": "<string>",
      "logoUrl": "<string>",
      "weekStart": "<string>",
      "brandColor": "<string>",
      "darkBrandColor": "<string>",
      "theme": "<string>"
    },
    "lengthInMinutesOptions": [
      15,
      30,
      60
    ],
    "slotInterval": 60,
    "minimumBookingNotice": 0,
    "beforeEventBuffer": 0,
    "afterEventBuffer": 0,
    "seatsPerTimeSlot": {},
    "seatsShowAvailabilityCount": true,
    "bookingLimitsCount": {},
    "bookerActiveBookingsLimit": {
      "maximumActiveBookings": 3,
      "offerReschedule": true
    },
    "onlyShowFirstAvailableSlot": true,
    "bookingLimitsDuration": {},
    "bookingWindow": [
      {
        "type": "businessDays",
        "value": 5,
        "rolling": true
      }
    ],
    "bookerLayouts": {
      "defaultLayout": "month",
      "enabledLayouts": [
        "month"
      ]
    },
    "confirmationPolicy": {},
    "requiresBookerEmailVerification": true,
    "hideCalendarNotes": true,
    "color": {
      "lightThemeHex": "#292929",
      "darkThemeHex": "#fafafa"
    },
    "seats": {
      "seatsPerTimeSlot": 4,
      "showAttendeeInfo": true,
      "showAvailabilityCount": true
    },
    "offsetStart": 123,
    "customName": "<string>",
    "destinationCalendar": {
      "integration": "<string>",
      "externalId": "<string>"
    },
    "useDestinationCalendarEmail": true,
    "hideCalendarEventDetails": true,
    "hideOrganizerEmail": true,
    "calVideoSettings": {
      "disableRecordingForOrganizer": true,
      "disableRecordingForGuests": true,
      "redirectUrlOnExit": {},
      "enableAutomaticRecordingForOrganizer": true,
      "enableAutomaticTranscription": true,
      "disableTranscriptionForGuests": true,
      "disableTranscriptionForOrganizer": true
    },
    "ownerId": {},
    "parentEventTypeId": {},
    "assignAllTeamMembers": true,
    "emailSettings": {
      "disableEmailsToAttendees": true,
      "disableEmailsToHosts": true
    },
    "rescheduleWithSameRoundRobinHost": true
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Authorization
string

For non-platform customers - value must be Bearer <token> where <token> is api key prefixed with cal_

​
x-cal-secret-key
string

For platform customers - OAuth client secret key

​
x-cal-client-id
string

For platform customers - OAuth client ID

Path Parameters

​
teamId
number
required
​
orgId
number
required

Body

application/json
​
lengthInMinutes
number
required
Example:

60

​
title
string
required
Example:

"Learn the secrets of masterchief!"

​
slug
string
required
Example:

"learn-the-secrets-of-masterchief"

​
schedulingType
enum<string>
required

The scheduling type for the team event - collective, roundRobin or managed.

Available options:
collective,
roundRobin,
managed
Example:

"collective"

​
lengthInMinutesOptions
string[]

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

Example:
[15, 30, 60]
​
description
string
Example:

"Discover the culinary wonders of the Argentina by making the best flan ever!"

​
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.

  • Option 1
  • Option 2
  • Option 3
  • Option 4
  • Option 5
  • Option 6
  • Option 7
  • Option 8
  • Option 9
  • Option 10
  • Option 11
  • Option 12
  • Option 13
  • Option 14
  • Option 15
  • Option 16
  • Option 17
  • Option 18
  • Option 19
​
disableGuests
boolean

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

​
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.

​
minimumBookingNotice
number

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

​
beforeEventBuffer
number

Time spaces that can be prepended before an event to give more time before it.

​
afterEventBuffer
number

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

​
scheduleId
number

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

​
bookingLimitsCount
object

Limit how many times this event can be booked

  • Option 1
  • Option 2
​
bookerActiveBookingsLimit
object

Limit the number of active bookings a booker can make for this event type.

  • Option 1
  • Option 2
​
onlyShowFirstAvailableSlot
boolean

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

​
bookingLimitsDuration
object

Limit total amount of time that this event can be booked

  • Option 1
  • Option 2
​
bookingWindow
object

Limit how far in the future this event can be booked

  • Option 1
  • Option 2
  • Option 3
  • Option 4
​
offsetStart
number

Offset timeslots shown to bookers by a specified number of minutes

​
bookerLayouts
object

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

​
confirmationPolicy
object

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

  • Option 1
  • Option 2
​
recurrence
object

Create a recurring event type.

  • Option 1
  • Option 2
​
requiresBookerEmailVerification
boolean
​
hideCalendarNotes
boolean
​
lockTimeZoneToggleOnBookingPage
boolean
​
color
object
​
seats
object

Create an event type with multiple seats.

  • Option 1
  • Option 2
​
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}

Example:

"{Event type title} between {Organiser} and {Scheduler}"

​
destinationCalendar
object
​
useDestinationCalendarEmail
boolean
​
hideCalendarEventDetails
boolean
​
successRedirectUrl
string

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

Example:

"https://masterchief.com/argentina/flan/video/9129412"

​
hideOrganizerEmail
boolean

Boolean to Hide organizer's email address from the booking screen, email notifications, and calendar events

​
calVideoSettings
object

Cal video settings for the event type. Platform customers can't manage this property because currently we have no way of determining if managed user is a host or an attendee.

​
hidden
boolean
​
bookingRequiresAuthentication
boolean
default:false

Boolean to require authentication for booking this event type via api. If true, only authenticated users who are the event-type owner or org/team admin/owner can book this event type.

​
hosts
object[]

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. Provide either hosts or assignAllTeamMembers but not both

​
assignAllTeamMembers
boolean

If true, all current and future team members will be assigned to this event type. Provide either assignAllTeamMembers or hosts but not both

​
locations
object[]

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

  • Option 1
  • Option 2
  • Option 3
  • Option 4
  • Option 5
  • Option 6
  • Option 7
  • Option 8
​
emailSettings
object

Email settings for this event type - only available for organization team event types.

​
rescheduleWithSameRoundRobinHost
boolean

Rescheduled events will be assigned to the same host as initially scheduled.

Response

201 - application/json
​
status
enum<string>
required
Available options:
success,
error
Example:

"success"

​
data
object
required
  • object
  • object[]