> ## Documentation Index > Fetch the complete documentation index at: https://cal.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Update a team event type > If accessed using an OAuth access token, the `TEAM_EVENT_TYPE_WRITE` scope is required. ## OpenAPI ````yaml /api-reference/v2/openapi.json patch /v2/teams/{teamId}/event-types/{eventTypeId} openapi: 3.0.0 info: title: Cal.com API v2 description: '' version: 1.0.0 contact: {} servers: [] security: [] tags: [] paths: /v2/teams/{teamId}/event-types/{eventTypeId}: patch: tags: - Teams / Event Types summary: Update a team event type description: >- If accessed using an OAuth access token, the `TEAM_EVENT_TYPE_WRITE` scope is required. operationId: TeamsEventTypesController_updateTeamEventType parameters: - name: teamId required: true in: path schema: type: number - name: eventTypeId required: true in: path schema: type: number - name: Authorization in: header description: >- value must be `Bearer ` where `` is api key prefixed with cal_ required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateTeamEventTypeInput_2024_06_14' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/UpdateTeamEventTypeOutput' components: schemas: UpdateTeamEventTypeInput_2024_06_14: type: object properties: lengthInMinutes: type: number example: 60 lengthInMinutesOptions: example: - 15 - 30 - 60 description: >- If you want that user can choose between different lengths of the event you can specify them here. Must include the provided `lengthInMinutes`. type: array items: type: number title: type: string example: Learn the secrets of masterchief! slug: type: string example: learn-the-secrets-of-masterchief description: type: string example: >- Discover the culinary wonders of the Argentina by making the best flan ever! 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. items: oneOf: - $ref: '#/components/schemas/NameDefaultFieldInput_2024_06_14' - $ref: '#/components/schemas/SplitNameDefaultFieldInput_2024_06_14' - $ref: '#/components/schemas/EmailDefaultFieldInput_2024_06_14' - $ref: '#/components/schemas/TitleDefaultFieldInput_2024_06_14' - $ref: '#/components/schemas/LocationDefaultFieldInput_2024_06_14' - $ref: '#/components/schemas/NotesDefaultFieldInput_2024_06_14' - $ref: '#/components/schemas/GuestsDefaultFieldInput_2024_06_14' - $ref: >- #/components/schemas/RescheduleReasonDefaultFieldInput_2024_06_14 - $ref: '#/components/schemas/PhoneFieldInput_2024_06_14' - $ref: '#/components/schemas/AddressFieldInput_2024_06_14' - $ref: '#/components/schemas/TextFieldInput_2024_06_14' - $ref: '#/components/schemas/NumberFieldInput_2024_06_14' - $ref: '#/components/schemas/TextAreaFieldInput_2024_06_14' - $ref: '#/components/schemas/SelectFieldInput_2024_06_14' - $ref: '#/components/schemas/MultiSelectFieldInput_2024_06_14' - $ref: '#/components/schemas/MultiEmailFieldInput_2024_06_14' - $ref: '#/components/schemas/CheckboxGroupFieldInput_2024_06_14' - $ref: '#/components/schemas/RadioGroupFieldInput_2024_06_14' - $ref: '#/components/schemas/BooleanFieldInput_2024_06_14' disableGuests: type: boolean description: >- If true, person booking this event can't add guests via their emails. 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. minimumBookingNotice: type: number description: >- Minimum number of minutes before the event that a booking can be made. 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. 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. scheduleId: type: number description: >- If you want that this event has different schedule than user's default one you can specify it here. bookingLimitsCount: description: Limit how many times this event can be booked oneOf: - $ref: '#/components/schemas/BaseBookingLimitsCount_2024_06_14' - $ref: '#/components/schemas/Disabled_2024_06_14' bookerActiveBookingsLimit: description: >- Limit the number of active bookings a booker can make for this event type. oneOf: - $ref: '#/components/schemas/BookerActiveBookingsLimit_2024_06_14' - $ref: '#/components/schemas/Disabled_2024_06_14' onlyShowFirstAvailableSlot: type: boolean description: >- This will limit your availability for this event type to one slot per day, scheduled at the earliest available time. bookingLimitsDuration: description: Limit total amount of time that this event can be booked oneOf: - $ref: '#/components/schemas/BaseBookingLimitsDuration_2024_06_14' - $ref: '#/components/schemas/Disabled_2024_06_14' bookingWindow: description: Limit how far in the future this event can be booked oneOf: - $ref: '#/components/schemas/BusinessDaysWindow_2024_06_14' - $ref: '#/components/schemas/CalendarDaysWindow_2024_06_14' - $ref: '#/components/schemas/RangeWindow_2024_06_14' - $ref: '#/components/schemas/Disabled_2024_06_14' offsetStart: type: number description: Offset timeslots shown to bookers by a specified number of minutes bookerLayouts: description: >- Should booker have week, month or column view. Specify default layout and enabled layouts user can pick. allOf: - $ref: '#/components/schemas/BookerLayouts_2024_06_14' confirmationPolicy: description: >- Specify how the booking needs to be manually confirmed before it is pushed to the integrations and a confirmation mail is sent. oneOf: - $ref: '#/components/schemas/BaseConfirmationPolicy_2024_06_14' - $ref: '#/components/schemas/Disabled_2024_06_14' recurrence: description: Create a recurring event type. oneOf: - $ref: '#/components/schemas/Recurrence_2024_06_14' - $ref: '#/components/schemas/Disabled_2024_06_14' requiresBookerEmailVerification: type: boolean hideCalendarNotes: type: boolean lockTimeZoneToggleOnBookingPage: type: boolean color: $ref: '#/components/schemas/EventTypeColor_2024_06_14' seats: description: Create an event type with multiple seats. oneOf: - $ref: '#/components/schemas/Seats_2024_06_14' - $ref: '#/components/schemas/Disabled_2024_06_14' 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} example: '{Event type title} between {Organiser} and {Scheduler}' destinationCalendar: $ref: '#/components/schemas/DestinationCalendar_2024_06_14' useDestinationCalendarEmail: type: boolean hideCalendarEventDetails: type: boolean successRedirectUrl: type: string description: >- A valid URL where the booker will redirect to, once the booking is completed successfully example: https://masterchief.com/argentina/flan/video/9129412 hideOrganizerEmail: type: boolean description: >- Boolean to Hide organizer's email address from the booking screen, email notifications, and calendar events calVideoSettings: description: Cal video settings for the event type allOf: - $ref: '#/components/schemas/CalVideoSettings' hidden: type: boolean bookingRequiresAuthentication: type: boolean default: false 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. disableCancelling: description: Settings for disabling cancelling of this event type. example: disabled: true allOf: - $ref: '#/components/schemas/DisableCancelling_2024_06_14' disableRescheduling: description: >- Settings for disabling rescheduling of this event type. Can be always disabled or disabled when less than X minutes before the meeting. example: disabled: false minutesBefore: 60 allOf: - $ref: '#/components/schemas/DisableRescheduling_2024_06_14' 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 allowReschedulingPastBookings: type: boolean description: Enabling this option allows for past events to be rescheduled. default: false allowReschedulingCancelledBookings: type: boolean description: >- When enabled, users will be able to create a new booking when trying to reschedule a cancelled booking. default: false showOptimizedSlots: type: boolean description: Arrange time slots to optimize availability. default: false schedulingType: type: string enum: - collective - roundRobin example: collective description: >- The scheduling type for the team event - collective or roundRobin. ❗If you change scheduling type you must also provide `hosts` or `assignAllTeamMembers` in the request body, otherwise the event type will have no hosts - this is required because in case of collective event type all hosts are mandatory but in case of round robin some or non can be mandatory so we can't predict how you want the hosts to be setup which is why you must provide that information. If you want to convert round robin or collective into managed or managed into round robin or collective then you will have to create a new team event type and delete old one. hosts: description: >- 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 type: array items: $ref: '#/components/schemas/Host' assignAllTeamMembers: type: boolean description: >- If true, all current and future team members will be assigned to this event type. Provide either assignAllTeamMembers or hosts but not both 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. items: oneOf: - $ref: '#/components/schemas/InputAddressLocation_2024_06_14' - $ref: '#/components/schemas/InputLinkLocation_2024_06_14' - $ref: '#/components/schemas/InputIntegrationLocation_2024_06_14' - $ref: '#/components/schemas/InputPhoneLocation_2024_06_14' - $ref: '#/components/schemas/InputAttendeeAddressLocation_2024_06_14' - $ref: '#/components/schemas/InputAttendeePhoneLocation_2024_06_14' - $ref: '#/components/schemas/InputAttendeeDefinedLocation_2024_06_14' - $ref: '#/components/schemas/InputOrganizersDefaultApp_2024_06_14' emailSettings: description: >- Email settings for this event type. Only available for organization team event types. allOf: - $ref: '#/components/schemas/EmailSettings_2024_06_14' rescheduleWithSameRoundRobinHost: type: boolean description: >- Rescheduled events will be assigned to the same host as initially scheduled. UpdateTeamEventTypeOutput: type: object properties: status: type: string example: success enum: - success - error data: oneOf: - $ref: '#/components/schemas/TeamEventTypeOutput_2024_06_14' - type: array items: $ref: '#/components/schemas/TeamEventTypeOutput_2024_06_14' required: - status - data NameDefaultFieldInput_2024_06_14: type: object properties: type: type: string example: name description: >- only allowed value for type is `name`. Used for having 1 booking field for both first name and last name. label: type: string placeholder: type: string disableOnPrefill: type: boolean description: >- Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if URL contains query parameter `&name=bob`, the name field will be prefilled with this value and disabled. In case of Booker atom need to pass 'name' to defaultFormValues prop with the desired value e.g. `defaultFormValues={{name: 'bob'}}`. See guide https://cal.com/docs/platform/guides/booking-fields required: - type - label - placeholder SplitNameDefaultFieldInput_2024_06_14: type: object properties: type: type: string example: splitName description: >- only allowed value for type is `splitName`. Used to have 2 booking fields - 1 for first name and 1 for last name. firstNameLabel: type: string firstNamePlaceholder: type: string lastNameLabel: type: string lastNamePlaceholder: type: string lastNameRequired: type: boolean description: First name field is required but last name field is not by default. disableOnPrefill: type: boolean description: >- Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if URL contains query parameter `&firstName=bob&lastName=jones`, the first name and last name fields will be prefilled with this value and disabled. In case of Booker atom need to pass 'firstName' and 'lastName' to defaultFormValues prop e.g. `defaultFormValues={{firstName: 'bob', lastName: 'doe'}}` or pass 'name' prop but as a string containing name and surname e.g. `defaultFormValues={{name: 'bob doe'}}`. See guide https://cal.com/docs/platform/guides/booking-fields required: - type - firstNameLabel - firstNamePlaceholder - lastNameLabel - lastNamePlaceholder - lastNameRequired EmailDefaultFieldInput_2024_06_14: type: object properties: type: type: string example: email description: only allowed value for type is `email` label: type: string required: type: boolean description: >- Can be set to false only for organization team event types and if you also pass booking field {type: "phone", slug: "attendeePhoneNumber", required: true, hidden: false, label: "whatever label"} of booking field type PhoneFieldInput_2024_06_14 - this is done to enable phone only bookings where during the booking attendee can provide only their phone number and not provide email, so you must pass to the email booking field {hidden: true, required: false}. If true show under event type settings but don't show this booking field in the Booker. If false show in both. hidden: type: boolean description: >- Can be set to true only for organization team event types and if you also pass booking field {type: "phone", slug: "attendeePhoneNumber", required: true, hidden: false, label: "whatever label"} of booking field type PhoneFieldInput_2024_06_14 - this is done to enable phone only bookings where during the booking attendee can provide only their phone number and not provide email, so you must pass to the email booking field {hidden: true, required: false}. If true show under event type settings but don't show this booking field in the Booker. If false show in both. placeholder: type: string disableOnPrefill: type: boolean description: >- Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if URL contains query parameter `&email=bob@gmail.com`, the email field will be prefilled with this value and disabled. In case of Booker atom need to pass 'email' to defaultFormValues prop with the desired value e.g. `defaultFormValues={{email: 'bob@gmail.com'}}`. See guide https://cal.com/docs/platform/guides/booking-field required: - type - label - placeholder TitleDefaultFieldInput_2024_06_14: type: object properties: slug: type: string example: title description: only allowed value for type is `title` required: type: boolean hidden: type: boolean description: >- If true show under event type settings but don't show this booking field in the Booker. If false show in both. label: type: string placeholder: type: string disableOnPrefill: type: boolean description: >- Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if URL contains query parameter `&title=journey`, the title field will be prefilled with this value and disabled. In case of Booker atom need to pass 'title' to defaultFormValues prop with the desired value e.g. `defaultFormValues={{title: 'very important meeting'}}`. See guide https://cal.com/docs/platform/guides/booking-field required: - slug LocationDefaultFieldInput_2024_06_14: type: object properties: slug: type: string example: location description: >- only allowed value for type is `location`. This booking field is displayed only when event type has 2 or more locations in order to allow person doing the booking pick the location. label: type: string required: - slug NotesDefaultFieldInput_2024_06_14: type: object properties: slug: type: string example: notes description: only allowed value for type is `notes` required: type: boolean hidden: type: boolean description: >- If true show under event type settings but don't show this booking field in the Booker. If false show in both. label: type: string placeholder: type: string disableOnPrefill: type: boolean description: >- Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if URL contains query parameter `¬es=journey`, the notes field will be prefilled with this value and disabled. In case of Booker atom need to pass 'notes' to defaultFormValues prop with the desired value e.g. `defaultFormValues={{notes: 'bring notebook and paper'}}`. See guide https://cal.com/docs/platform/guides/booking-field required: - slug GuestsDefaultFieldInput_2024_06_14: type: object properties: slug: type: string example: guests description: only allowed value for type is `guests` required: type: boolean hidden: type: boolean description: >- If true show under event type settings but don't show this booking field in the Booker. If false show in both. label: type: string placeholder: type: string disableOnPrefill: type: boolean description: >- Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if URL contains query parameter `&guests=bob@cal.com`, the guests field will be prefilled with this value and disabled. In case of Booker atom need to pass 'guests' to defaultFormValues prop with the desired value e.g. `defaultFormValues={{guests: ['bob@gmail.com', 'alice@gmail.com']}}`. See guide https://cal.com/docs/platform/guides/booking-field required: - slug RescheduleReasonDefaultFieldInput_2024_06_14: type: object properties: slug: type: string example: rescheduleReason description: only allowed value for type is `rescheduleReason` required: type: boolean hidden: type: boolean description: >- If true show under event type settings but don't show this booking field in the Booker. If false show in both. label: type: string placeholder: type: string disableOnPrefill: type: boolean description: >- Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if URL contains query parameter `&rescheduleReason=travel`, the rescheduleReason field will be prefilled with this value and disabled. In case of Booker atom need to pass 'rescheduleReason' to defaultFormValues prop with the desired value e.g. `defaultFormValues={{rescheduleReason: 'bob'}}`. See guide https://cal.com/docs/platform/guides/booking-field required: - slug PhoneFieldInput_2024_06_14: type: object properties: type: type: string example: phone description: only allowed value for type is `phone` slug: type: string description: >- Unique identifier for the field in format `some-slug`. It is used to access response to this booking field during the booking. Special slug is `attendeePhoneNumber` - if you create a phone input field with this slug for organization team event type you can create an organization team event type that can be booked using phone without requiring an email by setting {"type": "email", "required": false, "hidden": true} to the email booking field input in the request body. example: some-slug label: type: string required: type: boolean placeholder: type: string disableOnPrefill: type: boolean description: >- Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if the slug is `phone` and the URL contains query parameter `&phone=1234567890`, the phone field will be prefilled with this value and disabled. In case of Booker atom need to pass slug you used for this booking field to defaultFormValues prop with the desired value e.g. `defaultFormValues={{phone: '+37122222222'}}`. See guide https://cal.com/docs/platform/guides/booking-field hidden: type: boolean description: >- If true show under event type settings but don't show this booking field in the Booker. If false show in both. required: - type - slug - label - required - placeholder - hidden AddressFieldInput_2024_06_14: type: object properties: type: type: string example: address description: only allowed value for type is `address` slug: type: string description: >- Unique identifier for the field in format `some-slug`. It is used to access response to this booking field during the booking example: some-slug label: type: string example: Please enter your address required: type: boolean placeholder: type: string example: e.g., 1234 Main St disableOnPrefill: type: boolean description: >- Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if the slug is `address` and the URL contains query parameter `&address=1234 Main St, London`, the address field will be prefilled with this value and disabled. In case of Booker atom need to pass slug you used for this booking field to defaultFormValues prop with the desired value e.g. `defaultFormValues={{address: 'mainstreat 10, new york'}}`. See guide https://cal.com/docs/platform/guides/booking-field hidden: type: boolean description: >- If true show under event type settings but don't show this booking field in the Booker. If false show in both. required: - type - slug - label - required - placeholder - hidden TextFieldInput_2024_06_14: type: object properties: type: type: string example: text description: only allowed value for type is `text` slug: type: string description: >- Unique identifier for the field in format `some-slug`. It is used to access response to this booking field during the booking example: some-slug label: type: string example: Please enter your text required: type: boolean placeholder: type: string example: e.g., Enter text here disableOnPrefill: type: boolean description: >- Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if the slug is `friend` and the URL contains query parameter `&friend=bob`, the text field will be prefilled with this value and disabled. In case of Booker atom need to pass slug you used for this booking field to defaultFormValues prop with the desired value e.g. `defaultFormValues={{friend: 'bob'}}`. See guide https://cal.com/docs/platform/guides/booking-field hidden: type: boolean description: >- If true show under event type settings but don't show this booking field in the Booker. If false show in both. required: - type - slug - label - required - placeholder - hidden NumberFieldInput_2024_06_14: type: object properties: type: type: string example: number description: only allowed value for type is `number` slug: type: string description: >- Unique identifier for the field in format `some-slug`. It is used to access response to this booking field during the booking example: some-slug label: type: string example: Please enter a number required: type: boolean placeholder: type: string example: e.g., 100 disableOnPrefill: type: boolean description: >- Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if the slug is `calories` and the URL contains query parameter `&calories=3000`, the number field will be prefilled with this value and disabled. In case of Booker atom need to pass slug you used for this booking field to defaultFormValues prop with the desired value e.g. `defaultFormValues={{calories: 3000}}`. See guide https://cal.com/docs/platform/guides/booking-field hidden: type: boolean description: >- If true show under event type settings but don't show this booking field in the Booker. If false show in both. required: - type - slug - label - required - placeholder - hidden TextAreaFieldInput_2024_06_14: type: object properties: type: type: string example: textarea description: only allowed value for type is `textarea` slug: type: string description: >- Unique identifier for the field in format `some-slug`. It is used to access response to this booking field during the booking example: some-slug label: type: string example: Please enter detailed information required: type: boolean placeholder: type: string example: e.g., Detailed description here... disableOnPrefill: type: boolean description: >- Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if the slug is `reflection` and the URL contains query parameter `&reflection=Today I shipped a feature`, the text area will be prefilled with this value and disabled. In case of Booker atom need to pass slug you used for this booking field to defaultFormValues prop with the desired value e.g. `defaultFormValues={{reflection: 'Today i shipped a feature'}}`. See guide https://cal.com/docs/platform/guides/booking-field hidden: type: boolean description: >- If true show under event type settings but don't show this booking field in the Booker. If false show in both. required: - type - slug - label - required - placeholder - hidden SelectFieldInput_2024_06_14: type: object properties: type: type: string example: select description: only allowed value for type is `select` slug: type: string description: >- Unique identifier for the field in format `some-slug`. It is used to access response to this booking field during the booking example: some-slug label: type: string example: Please select an option required: type: boolean placeholder: type: string example: Select... options: example: - Option 1 - Option 2 type: array items: type: string disableOnPrefill: type: boolean description: >- Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if the slug is `language` and options of this select field are ['english', 'italian'] and the URL contains query parameter `&language=italian`, the 'italian' will be selected and the select field will be disabled. In case of Booker atom need to pass slug you used for this booking field to defaultFormValues prop with the desired value e.g. `defaultFormValues={{language: 'italian'}}`. See guide https://cal.com/docs/platform/guides/booking-field hidden: type: boolean description: >- If true show under event type settings but don't show this booking field in the Booker. If false show in both. required: - type - slug - label - required - placeholder - options - hidden MultiSelectFieldInput_2024_06_14: type: object properties: type: type: string example: multiselect description: only allowed value for type is `multiselect` slug: type: string description: >- Unique identifier for the field in format `some-slug`. It is used to access response to this booking field during the booking example: some-slug label: type: string example: Please select multiple options required: type: boolean options: example: - Option 1 - Option 2 type: array items: type: string disableOnPrefill: type: boolean description: >- Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if the slug is `language` and the URL contains query parameter `&language=en&language=it`, the 'en' and 'it' will be selected and the select field will be disabled. In case of Booker atom need to pass slug you used for this booking field to defaultFormValues prop with the desired value e.g. `defaultFormValues={{language: ['en', 'it']}}`. See guide https://cal.com/docs/platform/guides/booking-field hidden: type: boolean description: >- If true show under event type settings but don't show this booking field in the Booker. If false show in both. required: - type - slug - label - required - options - hidden MultiEmailFieldInput_2024_06_14: type: object properties: type: type: string example: multiemail description: only allowed value for type is `multiemail` slug: type: string description: >- Unique identifier for the field in format `some-slug`. It is used to access response to this booking field during the booking example: some-slug label: type: string example: Please enter multiple emails required: type: boolean placeholder: type: string example: e.g., example@example.com disableOnPrefill: type: boolean description: >- Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if the slug is `consultants` and the URL contains query parameter `&consultants=alice@gmail.com&consultants=bob@gmail.com`, the these emails will be added and none more can be added. In case of Booker atom need to pass slug you used for this booking field to defaultFormValues prop with the desired value e.g. `defaultFormValues={{consultants: ['alice@gmail.com', 'bob@gmail.com']}}`. See guide https://cal.com/docs/platform/guides/booking-field hidden: type: boolean description: >- If true show under event type settings but don't show this booking field in the Booker. If false show in both. required: - type - slug - label - required - placeholder - hidden CheckboxGroupFieldInput_2024_06_14: type: object properties: type: type: string example: checkbox description: only allowed value for type is `checkbox` slug: type: string description: >- Unique identifier for the field in format `some-slug`. It is used to access response to this booking field during the booking example: some-slug label: type: string example: Select all that apply required: type: boolean options: example: - Checkbox 1 - Checkbox 2 type: array items: type: string disableOnPrefill: type: boolean description: >- Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if the slug is `notify` and the URL contains query parameter `¬ify=true`, the checkbox will be selected and the checkbox field will be disabled. In case of Booker atom need to pass slug you used for this booking field to defaultFormValues prop with the desired value e.g. `defaultFormValues={{notify: true}}`. See guide https://cal.com/docs/platform/guides/booking-field hidden: type: boolean description: >- If true show under event type settings but don't show this booking field in the Booker. If false show in both. required: - type - slug - label - required - options - hidden RadioGroupFieldInput_2024_06_14: type: object properties: type: type: string example: radio description: only allowed value for type is `radio` slug: type: string description: >- Unique identifier for the field in format `some-slug`. It is used to access response to this booking field during the booking example: some-slug label: type: string example: Select one option required: type: boolean options: example: - Radio 1 - Radio 2 type: array items: type: string disableOnPrefill: type: boolean description: >- Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if the slug is `language` and options of this select field are ['english', 'italian'] and the URL contains query parameter `&language=italian`, the 'italian' radio button will be selected and the select field will be disabled. In case of Booker atom need to pass slug you used for this booking field to defaultFormValues prop with the desired value e.g. `defaultFormValues={{language: 'italian'}}`. See guide https://cal.com/docs/platform/guides/booking-field hidden: type: boolean description: >- If true show under event type settings but don't show this booking field in the Booker. If false show in both. required: - type - slug - label - required - options - hidden BooleanFieldInput_2024_06_14: type: object properties: type: type: string example: boolean description: only allowed value for type is `boolean` slug: type: string description: >- Unique identifier for the field in format `some-slug`. It is used to access response to this booking field during the booking example: some-slug label: type: string example: Agree to terms? required: type: boolean disableOnPrefill: type: boolean description: >- Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if the slug is `notify` and the URL contains query parameter `¬ify=true`, the checkbox will be selected and the checkbox field will be disabled. In case of Booker atom need to pass slug you used for this booking field to defaultFormValues prop with the desired value e.g. `defaultFormValues={{notify: true}}`. See guide https://cal.com/docs/platform/guides/booking-field hidden: type: boolean description: >- If true show under event type settings but don't show this booking field in the Booker. If false show in both. required: - type - slug - label - required - hidden BaseBookingLimitsCount_2024_06_14: type: object properties: day: type: number description: The number of bookings per day example: 1 week: type: number description: The number of bookings per week example: 2 month: type: number description: The number of bookings per month example: 3 year: type: number description: The number of bookings per year example: 4 Disabled_2024_06_14: type: object properties: disabled: type: boolean description: >- Only acceptable value for the `disabled` property is `true`. It is used to reset the value of the property for which previously an object containing specific settings was passed. example: true required: - disabled BookerActiveBookingsLimit_2024_06_14: type: object properties: maximumActiveBookings: type: number description: >- The maximum number of active bookings a booker can have for this event type. example: 3 offerReschedule: type: boolean description: >- Whether to offer rescheduling the last active booking to the chosen time slot when limit is reached. BaseBookingLimitsDuration_2024_06_14: type: object properties: day: type: number description: The duration of bookings per day (must be a multiple of 15) example: 60 week: type: number description: The duration of bookings per week (must be a multiple of 15) example: 120 month: type: number description: The duration of bookings per month (must be a multiple of 15) example: 180 year: type: number description: The duration of bookings per year (must be a multiple of 15) example: 240 BusinessDaysWindow_2024_06_14: type: object properties: type: type: string enum: - businessDays - calendarDays - range description: >- Whether the window should be business days, calendar days or a range of dates value: type: number example: 5 description: How many business day into the future can this event be booked rolling: type: boolean example: true description: |2- 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). required: - type - value CalendarDaysWindow_2024_06_14: type: object properties: type: type: string enum: - businessDays - calendarDays - range description: >- Whether the window should be business days, calendar days or a range of dates value: type: number example: 5 description: How many calendar days into the future can this event be booked rolling: type: boolean example: true description: |2- 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). required: - type - value RangeWindow_2024_06_14: type: object properties: type: type: string enum: - businessDays - calendarDays - range description: >- Whether the window should be business days, calendar days or a range of dates value: example: - '2030-09-05' - '2030-09-09' description: Date range for when this event can be booked. type: array items: type: string required: - type - value BookerLayouts_2024_06_14: type: object properties: defaultLayout: type: string enum: - month - week - column enabledLayouts: type: array description: Array of valid layouts - month, week or column items: type: string enum: - month - week - column required: - defaultLayout - enabledLayouts BaseConfirmationPolicy_2024_06_14: type: object properties: type: type: string description: The policy that determines when confirmation is required enum: - always - time example: always noticeThreshold: description: >- The notice threshold required before confirmation is needed. Required when type is 'time'. allOf: - $ref: '#/components/schemas/NoticeThreshold_2024_06_14' blockUnconfirmedBookingsInBooker: type: boolean description: Unconfirmed bookings still block calendar slots. required: - type - blockUnconfirmedBookingsInBooker Recurrence_2024_06_14: type: object properties: interval: type: number example: 10 description: Repeats every {count} week | month | year occurrences: type: number example: 10 description: Repeats for a maximum of {count} events frequency: type: string enum: - yearly - monthly - weekly required: - interval - occurrences - frequency EventTypeColor_2024_06_14: type: object properties: lightThemeHex: type: string description: Color used for event types in light theme example: '#292929' darkThemeHex: type: string description: Color used for event types in dark theme example: '#fafafa' required: - lightThemeHex - darkThemeHex Seats_2024_06_14: type: object properties: seatsPerTimeSlot: type: number description: Number of seats available per time slot example: 4 showAttendeeInfo: type: boolean description: Show attendee information to other guests example: true showAvailabilityCount: type: boolean description: Display the count of available seats example: true required: - seatsPerTimeSlot - showAttendeeInfo - showAvailabilityCount DestinationCalendar_2024_06_14: type: object 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 CalVideoSettings: type: object properties: disableRecordingForOrganizer: type: boolean description: If true, the organizer will not be able to record the meeting disableRecordingForGuests: type: boolean description: If true, the guests will not be able to record the meeting redirectUrlOnExit: type: string description: URL to which participants are redirected when they exit the call nullable: true enableAutomaticRecordingForOrganizer: type: boolean description: >- If true, enables the automatic recording for the event when organizer joins the call enableAutomaticTranscription: type: boolean description: >- If true, enables the automatic transcription for the event whenever someone joins the call disableTranscriptionForGuests: type: boolean description: >- If true, the guests will not be able to receive transcription of the meeting disableTranscriptionForOrganizer: type: boolean description: >- If true, the organizer will not be able to receive transcription of the meeting sendTranscriptionEmails: type: boolean description: >- Send emails with the transcription of the Cal Video after the meeting ends. default: true DisableCancelling_2024_06_14: type: object properties: disabled: type: boolean description: If true, cancelling is always disabled for this event type. example: true DisableRescheduling_2024_06_14: type: object properties: disabled: type: boolean description: If true, rescheduling is always disabled for this event type. example: true minutesBefore: type: number description: >- Disable rescheduling when less than the specified number of minutes before the meeting. If set, `disabled` should be false or undefined. example: 60 Host: type: object properties: userId: type: number description: Which user is the host of this event mandatory: type: boolean description: >- Only relevant for round robin event types. If true then the user must attend round robin event always. priority: type: string enum: - lowest - low - medium - high - highest required: - userId InputAddressLocation_2024_06_14: type: object properties: type: type: string example: address description: only allowed value for type is `address` address: type: string example: 123 Example St, City, Country public: type: boolean required: - type - address - public InputLinkLocation_2024_06_14: type: object properties: type: type: string example: link description: only allowed value for type is `link` link: type: string example: https://customvideo.com/join/123456 public: type: boolean required: - type - link - public InputIntegrationLocation_2024_06_14: type: object properties: type: type: string example: integration description: only allowed value for type is `integration` integration: type: string example: cal-video enum: - cal-video - google-meet - zoom - whereby-video - whatsapp-video - webex-video - telegram-video - tandem - sylaps-video - skype-video - sirius-video - signal-video - shimmer-video - salesroom-video - roam-video - riverside-video - ping-video - office365-video - mirotalk-video - jitsi - jelly-video - jelly-conferencing - huddle - facetime-video - element-call-video - eightxeight-video - discord-video - demodesk-video - campfire-video required: - type - integration InputPhoneLocation_2024_06_14: type: object properties: type: type: string example: phone description: only allowed value for type is `phone` phone: type: string example: '+37120993151' public: type: boolean required: - type - phone - public InputAttendeeAddressLocation_2024_06_14: type: object properties: type: type: string example: attendeeAddress description: only allowed value for type is `attendeeAddress` required: - type InputAttendeePhoneLocation_2024_06_14: type: object properties: type: type: string example: attendeePhone description: only allowed value for type is `attendeePhone` required: - type InputAttendeeDefinedLocation_2024_06_14: type: object properties: type: type: string example: attendeeDefined description: only allowed value for type is `attendeeDefined` required: - type InputOrganizersDefaultApp_2024_06_14: type: object properties: type: type: string example: organizersDefaultApp description: only allowed value for type is `organizersDefaultApp` required: - type EmailSettings_2024_06_14: type: object properties: disableEmailsToAttendees: type: boolean description: >- Disables all email communication to attendees for this event type, including booking confirmations, reminders, and cancellations. This DOES NOT include emails sent by custom email workflows. disableEmailsToHosts: type: boolean description: >- Disables all email communication to hosts for this event type, including booking confirmations, reminders, and cancellations. This DOES NOT include emails sent by custom email workflows. TeamEventTypeOutput_2024_06_14: type: object properties: id: type: number example: 1 lengthInMinutes: type: number example: 60 lengthInMinutesOptions: example: - 15 - 30 - 60 description: >- If you want that user can choose between different lengths of the event you can specify them here. Must include the provided `lengthInMinutes`. type: array items: type: number title: type: string example: Learn the secrets of masterchief! slug: type: string example: learn-the-secrets-of-masterchief description: type: string example: >- Discover the culinary wonders of Argentina by making the best flan ever! locations: type: array items: oneOf: - $ref: '#/components/schemas/OutputAddressLocation_2024_06_14' - $ref: '#/components/schemas/OutputLinkLocation_2024_06_14' - $ref: '#/components/schemas/OutputIntegrationLocation_2024_06_14' - $ref: '#/components/schemas/OutputPhoneLocation_2024_06_14' - $ref: >- #/components/schemas/OutputOrganizersDefaultAppLocation_2024_06_14 - $ref: '#/components/schemas/OutputUnknownLocation_2024_06_14' bookingFields: type: array items: oneOf: - $ref: '#/components/schemas/NameDefaultFieldOutput_2024_06_14' - $ref: '#/components/schemas/EmailDefaultFieldOutput_2024_06_14' - $ref: '#/components/schemas/LocationDefaultFieldOutput_2024_06_14' - $ref: >- #/components/schemas/RescheduleReasonDefaultFieldOutput_2024_06_14 - $ref: '#/components/schemas/TitleDefaultFieldOutput_2024_06_14' - $ref: '#/components/schemas/NotesDefaultFieldOutput_2024_06_14' - $ref: '#/components/schemas/GuestsDefaultFieldOutput_2024_06_14' - $ref: '#/components/schemas/PhoneFieldOutput_2024_06_14' - $ref: '#/components/schemas/AddressFieldOutput_2024_06_14' - $ref: '#/components/schemas/TextFieldOutput_2024_06_14' - $ref: '#/components/schemas/NumberFieldOutput_2024_06_14' - $ref: '#/components/schemas/TextAreaFieldOutput_2024_06_14' - $ref: '#/components/schemas/SelectFieldOutput_2024_06_14' - $ref: '#/components/schemas/MultiSelectFieldOutput_2024_06_14' - $ref: '#/components/schemas/MultiEmailFieldOutput_2024_06_14' - $ref: '#/components/schemas/CheckboxGroupFieldOutput_2024_06_14' - $ref: '#/components/schemas/RadioGroupFieldOutput_2024_06_14' - $ref: '#/components/schemas/BooleanFieldOutput_2024_06_14' - $ref: '#/components/schemas/UrlFieldOutput_2024_06_14' disableGuests: type: boolean slotInterval: type: number example: 60 nullable: true minimumBookingNotice: type: number example: 0 beforeEventBuffer: type: number example: 0 afterEventBuffer: type: number example: 0 recurrence: nullable: true allOf: - $ref: '#/components/schemas/Recurrence_2024_06_14' metadata: type: object price: type: number currency: type: string lockTimeZoneToggleOnBookingPage: type: boolean seatsPerTimeSlot: type: number nullable: true forwardParamsSuccessRedirect: type: boolean nullable: true successRedirectUrl: type: string nullable: true isInstantEvent: type: boolean seatsShowAvailabilityCount: type: boolean nullable: true scheduleId: type: number nullable: true bookingLimitsCount: oneOf: - $ref: '#/components/schemas/BaseBookingLimitsCount_2024_06_14' - $ref: '#/components/schemas/Disabled_2024_06_14' bookerActiveBookingsLimit: $ref: '#/components/schemas/BookerActiveBookingsLimitOutput_2024_06_14' onlyShowFirstAvailableSlot: type: boolean bookingLimitsDuration: oneOf: - $ref: '#/components/schemas/BaseBookingLimitsDuration_2024_06_14' - $ref: '#/components/schemas/Disabled_2024_06_14' bookingWindow: type: array description: Limit how far in the future this event can be booked items: oneOf: - $ref: '#/components/schemas/BusinessDaysWindow_2024_06_14' - $ref: '#/components/schemas/CalendarDaysWindow_2024_06_14' - $ref: '#/components/schemas/RangeWindow_2024_06_14' bookerLayouts: $ref: '#/components/schemas/BookerLayouts_2024_06_14' confirmationPolicy: oneOf: - $ref: '#/components/schemas/BaseConfirmationPolicy_2024_06_14' - $ref: '#/components/schemas/Disabled_2024_06_14' requiresBookerEmailVerification: type: boolean hideCalendarNotes: type: boolean color: $ref: '#/components/schemas/EventTypeColor_2024_06_14' seats: $ref: '#/components/schemas/Seats_2024_06_14' offsetStart: type: number customName: type: string destinationCalendar: $ref: '#/components/schemas/DestinationCalendar_2024_06_14' useDestinationCalendarEmail: type: boolean hideCalendarEventDetails: type: boolean hideOrganizerEmail: type: boolean description: >- Boolean to Hide organizer's email address from the booking screen, email notifications, and calendar events calVideoSettings: description: Cal video settings for the event type allOf: - $ref: '#/components/schemas/CalVideoSettings' hidden: type: boolean 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. disableCancelling: description: Settings for disabling cancelling of this event type. allOf: - $ref: '#/components/schemas/DisableCancellingOutput_2024_06_14' disableRescheduling: description: >- Settings for disabling rescheduling of this event type. Can be always disabled or disabled when less than X minutes before the meeting. allOf: - $ref: '#/components/schemas/DisableReschedulingOutput_2024_06_14' interfaceLanguage: type: string nullable: true description: Set preferred language for the booking interface. allowReschedulingPastBookings: type: boolean description: Enabling this option allows for past events to be rescheduled. allowReschedulingCancelledBookings: type: boolean nullable: true description: >- When enabled, users will be able to create a new booking when trying to reschedule a cancelled booking. showOptimizedSlots: type: boolean nullable: true description: Arrange time slots to optimize availability. teamId: type: number bookingUrl: type: string description: >- Full URL to the booking page for this team event type. Null for managed team event types or when the team does not have a slug. example: https://cal.com/team/acme/30min format: uri nullable: true ownerId: type: number nullable: true parentEventTypeId: type: number description: >- For managed event types, parent event type is the event type that this event type is based on nullable: true hosts: type: array items: $ref: '#/components/schemas/TeamEventTypeResponseHost' assignAllTeamMembers: type: boolean schedulingType: type: string enum: - roundRobin - collective - managed team: $ref: '#/components/schemas/EventTypeTeam' emailSettings: description: >- Email settings for this event type. Only available for organization team event types. allOf: - $ref: '#/components/schemas/EmailSettings_2024_06_14' rescheduleWithSameRoundRobinHost: type: boolean description: >- Rescheduled events will be assigned to the same host as initially scheduled. required: - id - lengthInMinutes - title - slug - description - locations - bookingFields - disableGuests - recurrence - metadata - price - currency - lockTimeZoneToggleOnBookingPage - forwardParamsSuccessRedirect - successRedirectUrl - isInstantEvent - scheduleId - hidden - bookingRequiresAuthentication - teamId - bookingUrl - hosts - schedulingType - team NoticeThreshold_2024_06_14: type: object properties: unit: type: string description: The unit of time for the notice threshold (e.g., minutes, hours) example: minutes count: type: number description: The time value for the notice threshold example: 30 required: - unit - count OutputAddressLocation_2024_06_14: type: object properties: type: type: string example: address description: only allowed value for type is `address` address: type: string example: 123 Example St, City, Country public: type: boolean required: - type - address - public OutputLinkLocation_2024_06_14: type: object properties: type: type: string example: link description: only allowed value for type is `link` link: type: string example: https://customvideo.com/join/123456 public: type: boolean required: - type - link - public OutputIntegrationLocation_2024_06_14: type: object properties: type: type: string example: integration description: Only allowed value for type is `integration` integration: type: string example: cal-video enum: - cal-video - google-meet - zoom - whereby-video - whatsapp-video - webex-video - telegram-video - tandem - sylaps-video - skype-video - sirius-video - signal-video - shimmer-video - salesroom-video - roam-video - riverside-video - ping-video - office365-video - mirotalk-video - jitsi - jelly-video - jelly-conferencing - huddle - facetime-video - element-call-video - eightxeight-video - discord-video - demodesk-video - campfire-video link: type: string example: https://example.com credentialId: type: number description: Credential ID associated with the integration required: - type - integration OutputPhoneLocation_2024_06_14: type: object properties: type: type: string example: phone description: only allowed value for type is `phone` phone: type: string example: '+37120993151' public: type: boolean required: - type - phone - public OutputOrganizersDefaultAppLocation_2024_06_14: type: object properties: type: type: string example: organizersDefaultApp description: only allowed value for type is `organizersDefaultApp` required: - type OutputUnknownLocation_2024_06_14: type: object properties: type: type: string example: unknown description: only allowed value for type is `unknown` location: type: string required: - type - location NameDefaultFieldOutput_2024_06_14: type: object properties: type: type: string example: name description: >- only allowed value for type is `name`. Used for having 1 booking field for both first name and last name. default: name label: type: string placeholder: type: string disableOnPrefill: type: boolean description: >- Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if URL contains query parameter `&name=bob`, the name field will be prefilled with this value and disabled. In case of Booker atom need to pass 'name' to defaultFormValues prop with the desired value e.g. `defaultFormValues={{name: 'bob'}}`. See guide https://cal.com/docs/platform/guides/booking-fields isDefault: type: boolean description: This property is always true because it's a default field example: true default: true slug: type: string default: name required: type: boolean required: - type - label - placeholder - isDefault - slug - required EmailDefaultFieldOutput_2024_06_14: type: object properties: type: type: string example: email description: only allowed value for type is `email` default: email label: type: string required: type: boolean description: >- Can be set to false only for organization team event types and if you also pass booking field {type: "phone", slug: "attendeePhoneNumber", required: true, hidden: false, label: "whatever label"} of booking field type PhoneFieldInput_2024_06_14 - this is done to enable phone only bookings where during the booking attendee can provide only their phone number and not provide email, so you must pass to the email booking field {hidden: true, required: false}. If true show under event type settings but don't show this booking field in the Booker. If false show in both. hidden: type: boolean description: >- If true show under event type settings but don't show this booking field in the Booker. If false show in both. Can only be hidden for organization team event types when also providing attendee phone number booking field. placeholder: type: string disableOnPrefill: type: boolean description: >- Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if URL contains query parameter `&email=bob@gmail.com`, the email field will be prefilled with this value and disabled. In case of Booker atom need to pass 'email' to defaultFormValues prop with the desired value e.g. `defaultFormValues={{email: 'bob@gmail.com'}}`. See guide https://cal.com/docs/platform/guides/booking-field isDefault: type: boolean description: This property is always true because it's a default field example: true default: true slug: type: string default: email required: - type - label - placeholder - isDefault - slug LocationDefaultFieldOutput_2024_06_14: type: object properties: isDefault: type: boolean description: This property is always true because it's a default field example: true default: true slug: type: string default: location description: >- This booking field is returned only if the event type has more than one location. The purpose of this field is to allow the user to select the location where the event will take place. type: type: string default: radioInput required: type: boolean hidden: type: boolean description: >- If true show under event type settings but don't show this booking field in the Booker. If false show in both. label: type: string required: - isDefault - slug - type - required - hidden - label RescheduleReasonDefaultFieldOutput_2024_06_14: type: object properties: slug: type: string example: rescheduleReason description: only allowed value for type is `rescheduleReason` default: rescheduleReason required: type: boolean hidden: type: boolean description: >- If true show under event type settings but don't show this booking field in the Booker. If false show in both. label: type: string placeholder: type: string disableOnPrefill: type: boolean description: >- Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if URL contains query parameter `&rescheduleReason=busy`, the reschedule reason field will be prefilled with this value and disabled. isDefault: type: boolean description: This property is always true because it's a default field example: true default: true type: type: string default: textarea required: - slug - isDefault - type TitleDefaultFieldOutput_2024_06_14: type: object properties: slug: type: string example: title description: only allowed value for type is `title` default: title required: type: boolean hidden: type: boolean description: >- If true show under event type settings but don't show this booking field in the Booker. If false show in both. label: type: string placeholder: type: string disableOnPrefill: type: boolean description: >- Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if URL contains query parameter `&title=masterclass`, the title field will be prefilled with this value and disabled. isDefault: type: boolean description: This property is always true because it's a default field example: true default: true type: type: string default: text required: - slug - isDefault - type NotesDefaultFieldOutput_2024_06_14: type: object properties: slug: type: string example: notes description: only allowed value for type is `notes` default: notes required: type: boolean hidden: type: boolean description: >- If true show under event type settings but don't show this booking field in the Booker. If false show in both. label: type: string placeholder: type: string disableOnPrefill: type: boolean description: >- Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if URL contains query parameter `¬es=hello`, the notes field will be prefilled with this value and disabled. isDefault: type: boolean description: This property is always true because it's a default field example: true default: true type: type: string default: textarea required: - slug - isDefault - type GuestsDefaultFieldOutput_2024_06_14: type: object properties: slug: type: string example: guests description: only allowed value for type is `guests` default: guests required: type: boolean hidden: type: boolean description: >- If true show under event type settings but don't show this booking field in the Booker. If false show in both. label: type: string placeholder: type: string disableOnPrefill: type: boolean description: >- Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if URL contains query parameter `&guests=lauris@cal.com`, the guests field will be prefilled with this value and disabled. isDefault: type: boolean description: This property is always true because it's a default field example: true default: true type: type: string default: multiemail required: - slug - isDefault - type PhoneFieldOutput_2024_06_14: type: object properties: type: type: string example: phone description: only allowed value for type is `phone` slug: type: string description: >- Unique identifier for the field in format `some-slug`. It is used to access response to this booking field during the booking. Special slug is `attendeePhoneNumber` - if you create a phone input field with this slug for organization team event type you can create an organization team event type that can be booked using phone without requiring an email by setting {"type": "email", "required": false, "hidden": true} to the email booking field input in the request body. example: some-slug label: type: string required: type: boolean placeholder: type: string disableOnPrefill: type: boolean description: >- Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if the slug is `phone` and the URL contains query parameter `&phone=1234567890`, the phone field will be prefilled with this value and disabled. In case of Booker atom need to pass slug you used for this booking field to defaultFormValues prop with the desired value e.g. `defaultFormValues={{phone: '+37122222222'}}`. See guide https://cal.com/docs/platform/guides/booking-field hidden: type: boolean description: >- If true show under event type settings but don't show this booking field in the Booker. If false show in both. isDefault: type: boolean description: >- This property is always false because it's not default field but custom field example: false default: false required: - type - slug - label - required - placeholder - hidden - isDefault AddressFieldOutput_2024_06_14: type: object properties: type: type: string example: address description: only allowed value for type is `address` slug: type: string description: >- Unique identifier for the field in format `some-slug`. It is used to access response to this booking field during the booking example: some-slug label: type: string example: Please enter your address required: type: boolean placeholder: type: string example: e.g., 1234 Main St disableOnPrefill: type: boolean description: >- Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if the slug is `address` and the URL contains query parameter `&address=1234 Main St, London`, the address field will be prefilled with this value and disabled. In case of Booker atom need to pass slug you used for this booking field to defaultFormValues prop with the desired value e.g. `defaultFormValues={{address: 'mainstreat 10, new york'}}`. See guide https://cal.com/docs/platform/guides/booking-field hidden: type: boolean description: >- If true show under event type settings but don't show this booking field in the Booker. If false show in both. isDefault: type: boolean description: >- This property is always false because it's not default field but custom field example: false default: false required: - type - slug - label - required - placeholder - hidden - isDefault TextFieldOutput_2024_06_14: type: object properties: type: type: string example: text description: only allowed value for type is `text` slug: type: string description: >- Unique identifier for the field in format `some-slug`. It is used to access response to this booking field during the booking example: some-slug label: type: string example: Please enter your text required: type: boolean placeholder: type: string example: e.g., Enter text here disableOnPrefill: type: boolean description: >- Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if the slug is `friend` and the URL contains query parameter `&friend=bob`, the text field will be prefilled with this value and disabled. In case of Booker atom need to pass slug you used for this booking field to defaultFormValues prop with the desired value e.g. `defaultFormValues={{friend: 'bob'}}`. See guide https://cal.com/docs/platform/guides/booking-field hidden: type: boolean description: >- If true show under event type settings but don't show this booking field in the Booker. If false show in both. isDefault: type: boolean description: >- This property is always false because it's not default field but custom field example: false default: false required: - type - slug - label - required - placeholder - hidden - isDefault NumberFieldOutput_2024_06_14: type: object properties: type: type: string example: number description: only allowed value for type is `number` slug: type: string description: >- Unique identifier for the field in format `some-slug`. It is used to access response to this booking field during the booking example: some-slug label: type: string example: Please enter a number required: type: boolean placeholder: type: string example: e.g., 100 disableOnPrefill: type: boolean description: >- Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if the slug is `calories` and the URL contains query parameter `&calories=3000`, the number field will be prefilled with this value and disabled. In case of Booker atom need to pass slug you used for this booking field to defaultFormValues prop with the desired value e.g. `defaultFormValues={{calories: 3000}}`. See guide https://cal.com/docs/platform/guides/booking-field hidden: type: boolean description: >- If true show under event type settings but don't show this booking field in the Booker. If false show in both. isDefault: type: boolean description: >- This property is always false because it's not default field but custom field example: false default: false required: - type - slug - label - required - placeholder - hidden - isDefault TextAreaFieldOutput_2024_06_14: type: object properties: type: type: string example: textarea description: only allowed value for type is `textarea` slug: type: string description: >- Unique identifier for the field in format `some-slug`. It is used to access response to this booking field during the booking example: some-slug label: type: string example: Please enter detailed information required: type: boolean placeholder: type: string example: e.g., Detailed description here... disableOnPrefill: type: boolean description: >- Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if the slug is `reflection` and the URL contains query parameter `&reflection=Today I shipped a feature`, the text area will be prefilled with this value and disabled. In case of Booker atom need to pass slug you used for this booking field to defaultFormValues prop with the desired value e.g. `defaultFormValues={{reflection: 'Today i shipped a feature'}}`. See guide https://cal.com/docs/platform/guides/booking-field hidden: type: boolean description: >- If true show under event type settings but don't show this booking field in the Booker. If false show in both. isDefault: type: boolean description: >- This property is always false because it's not default field but custom field example: false default: false required: - type - slug - label - required - placeholder - hidden - isDefault SelectFieldOutput_2024_06_14: type: object properties: type: type: string example: select description: only allowed value for type is `select` slug: type: string description: >- Unique identifier for the field in format `some-slug`. It is used to access response to this booking field during the booking example: some-slug label: type: string example: Please select an option required: type: boolean placeholder: type: string example: Select... options: example: - Option 1 - Option 2 type: array items: type: string disableOnPrefill: type: boolean description: >- Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if the slug is `language` and options of this select field are ['english', 'italian'] and the URL contains query parameter `&language=italian`, the 'italian' will be selected and the select field will be disabled. In case of Booker atom need to pass slug you used for this booking field to defaultFormValues prop with the desired value e.g. `defaultFormValues={{language: 'italian'}}`. See guide https://cal.com/docs/platform/guides/booking-field hidden: type: boolean description: >- If true show under event type settings but don't show this booking field in the Booker. If false show in both. isDefault: type: boolean description: >- This property is always false because it's not default field but custom field example: false default: false required: - type - slug - label - required - placeholder - options - hidden - isDefault MultiSelectFieldOutput_2024_06_14: type: object properties: type: type: string example: multiselect description: only allowed value for type is `multiselect` slug: type: string description: >- Unique identifier for the field in format `some-slug`. It is used to access response to this booking field during the booking example: some-slug label: type: string example: Please select multiple options required: type: boolean options: example: - Option 1 - Option 2 type: array items: type: string disableOnPrefill: type: boolean description: >- Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if the slug is `language` and the URL contains query parameter `&language=en&language=it`, the 'en' and 'it' will be selected and the select field will be disabled. In case of Booker atom need to pass slug you used for this booking field to defaultFormValues prop with the desired value e.g. `defaultFormValues={{language: ['en', 'it']}}`. See guide https://cal.com/docs/platform/guides/booking-field hidden: type: boolean description: >- If true show under event type settings but don't show this booking field in the Booker. If false show in both. isDefault: type: boolean description: >- This property is always false because it's not default field but custom field example: false default: false required: - type - slug - label - required - options - hidden - isDefault MultiEmailFieldOutput_2024_06_14: type: object properties: type: type: string example: multiemail description: only allowed value for type is `multiemail` slug: type: string description: >- Unique identifier for the field in format `some-slug`. It is used to access response to this booking field during the booking example: some-slug label: type: string example: Please enter multiple emails required: type: boolean placeholder: type: string example: e.g., example@example.com disableOnPrefill: type: boolean description: >- Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if the slug is `consultants` and the URL contains query parameter `&consultants=alice@gmail.com&consultants=bob@gmail.com`, the these emails will be added and none more can be added. In case of Booker atom need to pass slug you used for this booking field to defaultFormValues prop with the desired value e.g. `defaultFormValues={{consultants: ['alice@gmail.com', 'bob@gmail.com']}}`. See guide https://cal.com/docs/platform/guides/booking-field hidden: type: boolean description: >- If true show under event type settings but don't show this booking field in the Booker. If false show in both. isDefault: type: boolean description: >- This property is always false because it's not default field but custom field example: false default: false required: - type - slug - label - required - placeholder - hidden - isDefault CheckboxGroupFieldOutput_2024_06_14: type: object properties: type: type: string example: checkbox description: only allowed value for type is `checkbox` slug: type: string description: >- Unique identifier for the field in format `some-slug`. It is used to access response to this booking field during the booking example: some-slug label: type: string example: Select all that apply required: type: boolean options: example: - Checkbox 1 - Checkbox 2 type: array items: type: string disableOnPrefill: type: boolean description: >- Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if the slug is `notify` and the URL contains query parameter `¬ify=true`, the checkbox will be selected and the checkbox field will be disabled. In case of Booker atom need to pass slug you used for this booking field to defaultFormValues prop with the desired value e.g. `defaultFormValues={{notify: true}}`. See guide https://cal.com/docs/platform/guides/booking-field hidden: type: boolean description: >- If true show under event type settings but don't show this booking field in the Booker. If false show in both. isDefault: type: boolean description: >- This property is always false because it's not default field but custom field example: false default: false required: - type - slug - label - required - options - hidden - isDefault RadioGroupFieldOutput_2024_06_14: type: object properties: type: type: string example: radio description: only allowed value for type is `radio` slug: type: string description: >- Unique identifier for the field in format `some-slug`. It is used to access response to this booking field during the booking example: some-slug label: type: string example: Select one option required: type: boolean options: example: - Radio 1 - Radio 2 type: array items: type: string disableOnPrefill: type: boolean description: >- Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if the slug is `language` and options of this select field are ['english', 'italian'] and the URL contains query parameter `&language=italian`, the 'italian' radio button will be selected and the select field will be disabled. In case of Booker atom need to pass slug you used for this booking field to defaultFormValues prop with the desired value e.g. `defaultFormValues={{language: 'italian'}}`. See guide https://cal.com/docs/platform/guides/booking-field hidden: type: boolean description: >- If true show under event type settings but don't show this booking field in the Booker. If false show in both. isDefault: type: boolean description: >- This property is always false because it's not default field but custom field example: false default: false required: - type - slug - label - required - options - hidden - isDefault BooleanFieldOutput_2024_06_14: type: object properties: type: type: string example: boolean description: only allowed value for type is `boolean` slug: type: string description: >- Unique identifier for the field in format `some-slug`. It is used to access response to this booking field during the booking example: some-slug label: type: string example: Agree to terms? required: type: boolean disableOnPrefill: type: boolean description: >- Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if the slug is `notify` and the URL contains query parameter `¬ify=true`, the checkbox will be selected and the checkbox field will be disabled. In case of Booker atom need to pass slug you used for this booking field to defaultFormValues prop with the desired value e.g. `defaultFormValues={{notify: true}}`. See guide https://cal.com/docs/platform/guides/booking-field hidden: type: boolean description: >- If true show under event type settings but don't show this booking field in the Booker. If false show in both. isDefault: type: boolean description: >- This property is always false because it's not default field but custom field example: false default: false required: - type - slug - label - required - hidden - isDefault UrlFieldOutput_2024_06_14: type: object properties: type: type: string example: url description: only allowed value for type is `url` slug: type: string description: >- Unique identifier for the field in format `some-slug`. It is used to access response to this booking field during the booking example: some-slug label: type: string example: Please enter your text required: type: boolean placeholder: type: string example: e.g., Enter url here disableOnPrefill: type: boolean description: >- Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if the slug is `videourl` and the URL contains query parameter `&videourl=https://youtube.com/abc`the url field will be prefilled with this value and disabled. In case of Booker atom need to pass slug you used for this booking field to defaultFormValues prop with the desired value e.g. `defaultFormValues={{videourl: 'https://caltube.com/123'}}`. See guide https://cal.com/docs/platform/guides/booking-field hidden: type: boolean description: >- If true show under event type settings but don't show this booking field in the Booker. If false show in both. isDefault: type: boolean description: >- This property is always false because it's not default field but custom field example: false default: false required: - type - slug - label - required - placeholder - hidden - isDefault BookerActiveBookingsLimitOutput_2024_06_14: type: object properties: maximumActiveBookings: type: number description: >- The maximum number of active bookings a booker can have for this event type. example: 3 offerReschedule: type: boolean description: >- Whether to offer rescheduling the last active booking to the chosen time slot when limit is reached. DisableCancellingOutput_2024_06_14: type: object properties: disabled: type: boolean description: If true, cancelling is always disabled for this event type. example: true DisableReschedulingOutput_2024_06_14: type: object properties: disabled: type: boolean description: If true, rescheduling is always disabled for this event type. example: true minutesBefore: type: number description: >- Rescheduling is disabled when less than the specified number of minutes before the meeting. example: 60 TeamEventTypeResponseHost: type: object properties: userId: type: number description: Which user is the host of this event mandatory: type: boolean description: >- Only relevant for round robin event types. If true then the user must attend round robin event always. priority: type: string enum: - lowest - low - medium - high - highest name: type: string example: John Doe username: type: string example: john-doe avatarUrl: type: string example: https://cal.com/api/avatar/d95949bc-ccb1-400f-acf6-045c51a16856.png nullable: true required: - userId - name - username EventTypeTeam: type: object properties: id: type: number slug: type: string bannerUrl: type: string name: type: string logoUrl: type: string weekStart: type: string brandColor: type: string darkBrandColor: type: string theme: type: string required: - id - slug - bannerUrl - name - logoUrl - weekStart - brandColor - darkBrandColor - theme ````