{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"eventTypeId": {
"type": "number",
"description": "Event Type Id"
},
"afterEventBuffer": {
"type": "number",
"description": "Extra time automatically blocked on your calendar after a meeting ends. This gives you time to wrap up, add notes, or decompress before your next commitment."
},
"allowReschedulingCancelledBookings": {
"type": "boolean",
"description": "When enabled, users will be able to create a new booking when trying to reschedule a cancelled booking."
},
"allowReschedulingPastBookings": {
"type": "boolean",
"description": "Enabling this option allows for past events to be rescheduled."
},
"beforeEventBuffer": {
"type": "number",
"description": "Extra time automatically blocked on your calendar before a meeting starts. This gives you time to prepare, review notes, or transition from your previous activity."
},
"bookerActiveBookingsLimit": {
"description": "Limit the number of active bookings a booker can make for this event type."
},
"bookerLayouts": {
"description": "Should booker have week, month or column view. Specify default layout and enabled layouts user can pick."
},
"bookingFields": {
"type": "array",
"description": "Complete set of booking form fields. This array replaces all existing booking fields. To modify existing fields, first fetch the current event type, then include all desired fields in this array. Sending only one field will remove all other custom fields, keeping only default fields plus the provided one."
},
"bookingLimitsCount": {
"description": "Limit how many times this event can be booked"
},
"bookingLimitsDuration": {
"description": "Limit total amount of time that this event can be booked"
},
"bookingRequiresAuthentication": {
"type": "boolean",
"description": "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."
},
"bookingWindow": {
"description": "Limit how far in the future this event can be booked"
},
"calVideoSettings": {
"description": "Cal video settings for the event type"
},
"color": {
"type": "object",
"description": "The color value",
"properties": {
"lightThemeHex": {
"type": "string",
"description": "Color used for event types in light theme"
},
"darkThemeHex": {
"type": "string",
"description": "Color used for event types in dark theme"
}
},
"required": [
"lightThemeHex",
"darkThemeHex"
]
},
"confirmationPolicy": {
"description": "Specify how the booking needs to be manually confirmed before it is pushed to the integrations and a confirmation mail is sent."
},
"customName": {
"type": "string",
"description": "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": {
"type": "string",
"description": "The description value"
},
"destinationCalendar": {
"type": "object",
"description": "Destination Calendar",
"properties": {
"integration": {
"type": "string",
"description": "The integration type of the destination calendar. Refer to the /api/v2/calendars endpoint to retrieve the integration type of your connected calendars."
},
"externalId": {
"type": "string",
"description": "The external ID of the destination calendar. Refer to the /api/v2/calendars endpoint to retrieve the external IDs of your connected calendars."
}
},
"required": [
"integration",
"externalId"
]
},
"disableCancelling": {
"description": "Settings for disabling cancelling of this event type."
},
"disableGuests": {
"type": "boolean",
"description": "If true, person booking this event can't add guests via their emails."
},
"disableRescheduling": {
"description": "Settings for disabling rescheduling of this event type. Can be always disabled or disabled when less than X minutes before the meeting."
},
"hidden": {
"type": "boolean",
"description": "The hidden value"
},
"hideCalendarEventDetails": {
"type": "boolean",
"description": "Hide Calendar Event Details"
},
"hideCalendarNotes": {
"type": "boolean",
"description": "Hide Calendar Notes"
},
"hideOrganizerEmail": {
"type": "boolean",
"description": "Boolean to Hide organizer's email address from the booking screen, email notifications, and calendar events"
},
"interfaceLanguage": {
"type": "string",
"description": "Set preferred language for the booking interface. Use empty string for visitor's browser language (default).",
"enum": [
"",
"en",
"ar",
"az",
"bg",
"bn",
"ca",
"cs",
"da",
"de",
"el",
"es",
"es-419",
"eu",
"et",
"fi",
"fr",
"he",
"hu",
"it",
"ja",
"km",
"ko",
"nl",
"no",
"pl",
"pt-BR",
"pt",
"ro",
"ru",
"sk-SK",
"sr",
"sv",
"tr",
"uk",
"vi",
"zh-CN",
"zh-TW"
]
},
"lengthInMinutes": {
"type": "number",
"description": "Length In Minutes"
},
"lengthInMinutesOptions": {
"type": "array",
"items": {
"type": "string"
},
"description": "If you want that user can choose between different lengths of the event you can specify them here. Must include the provided `lengthInMinutes`."
},
"locations": {
"type": "array",
"description": "Locations where the event will take place. If not provided, cal video link will be used as the location. Note: Setting a location to a conferencing app does not install the app - the app must already be installed. Via API, only Google Meet (google-meet), Microsoft Teams (office365-video), and Zoom (zoom) can be installed. Cal Video (cal-video) is installed by default. All other conferencing apps must be connected via the Cal.com web app and are not available for Platform plan customers. You can only set an event type location to an app that has already been installed or connected."
},
"lockTimeZoneToggleOnBookingPage": {
"type": "boolean",
"description": "Lock Time Zone Toggle On Booking Page"
},
"minimumBookingNotice": {
"type": "number",
"description": "Minimum number of minutes before the event that a booking can be made."
},
"offsetStart": {
"type": "number",
"description": "Offset timeslots shown to bookers by a specified number of minutes"
},
"onlyShowFirstAvailableSlot": {
"type": "boolean",
"description": "This will limit your availability for this event type to one slot per day, scheduled at the earliest available time."
},
"recurrence": {
"description": "Create a recurring event type."
},
"requiresBookerEmailVerification": {
"type": "boolean",
"description": "Requires Booker Email Verification"
},
"scheduleId": {
"type": "number",
"description": "If you want that this event has different schedule than user's default one you can specify it here."
},
"seats": {
"description": "Create an event type with multiple seats."
},
"showOptimizedSlots": {
"type": "boolean",
"description": "Arrange time slots to optimize availability."
},
"slotInterval": {
"type": "number",
"description": "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."
},
"slug": {
"type": "string",
"description": "The slug value"
},
"successRedirectUrl": {
"type": "string",
"description": "A valid URL where the booker will redirect to, once the booking is completed successfully"
},
"title": {
"type": "string",
"description": "The title value"
},
"useDestinationCalendarEmail": {
"type": "boolean",
"description": "Use Destination Calendar Email"
}
},
"required": [
"PCID",
"eventTypeId"
]
}
