calendars_create_calendar
Create a new calendar in GoHighLevel with configurable booking rules, availability, and team assignment to manage appointments.
Instructions
Create Calendar
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | ||
| slug | No | ||
| notes | No | ||
| formId | No | ||
| groupId | No | Group Id | |
| pixelId | No | ||
| isActive | No | Should the created calendar be active or draft | |
| eventType | No | ||
| guestType | No | ||
| openHours | No | This is only to set the standard availability. For custom availability, use the availabilities property | |
| preBuffer | No | Pre-Buffer is additional time that can be added before an appointment, allowing for extra time to get ready | |
| recurring | No | ||
| alertEmail | No | ||
| eventColor | No | ||
| eventTitle | No | ||
| locationId | No | Defaults to GHL_LOCATION_ID when omitted. | |
| slotBuffer | No | Slot-Buffer is additional time that can be added after an appointment, allowing for extra time to wrap up | |
| widgetSlug | No | ||
| widgetType | No | Calendar widget type. Choose "default" for "neo" and "classic" for "classic" layout. | |
| autoConfirm | No | ||
| description | No | ||
| teamMembers | No | Team members are required for calendars of type: Round Robin, Collective, Class, Service. Personal calendar must have exactly one team member. | |
| calendarType | No | ||
| consentLabel | No | ||
| slotDuration | No | This controls the duration of the meeting | |
| slotInterval | No | Slot interval reflects the amount of time the between booking slots that will be shown in the calendar. | |
| notifications | No | 🚨 Deprecated! Please use 'Calendar Notifications APIs' instead. | |
| preBufferUnit | No | Unit for pre-buffer. | |
| stickyContact | No | ||
| availabilities | No | This is only to set the custom availability. For standard availability, use the openHours property | |
| formSubmitType | No | ||
| lookBusyConfig | No | Look Busy Configuration | |
| slotBufferUnit | No | Unit for slot buffer. | |
| allowBookingFor | No | Minimum number of days/weeks/months for which to allow booking events | |
| allowReschedule | No | ||
| enableRecurring | No | Enable recurring appointments for the calendars. Please note that only one member should be added in the calendar to enable this | |
| appoinmentPerDay | No | Number of appointments that can be booked for a given day | |
| availabilityType | No | Determines which availability type to consider: - **1**: Only custom availabilities will be used. - **0**: Only open hours will be used. - **null**: Both custom availabilities and open hours will be considered. | |
| slotDurationUnit | No | Unit for slot duration. | |
| slotIntervalUnit | No | Unit for slot interval. | |
| allowBookingAfter | No | Minimum scheduling notice for events | |
| allowCancellation | No | ||
| appoinmentPerSlot | No | Maximum bookings per slot (per user). Maximum seats per slot in case of Class Booking Calendar. | |
| isLivePaymentMode | No | ||
| calendarCoverImage | No | ||
| allowBookingForUnit | No | Unit for controlling the duration for which booking would be allowed for | |
| allowBookingAfterUnit | No | Unit for minimum scheduling notice | |
| formSubmitRedirectURL | No | ||
| googleInvitationEmails | No | ||
| locationConfigurations | No | Meeting location configuration for event calendar | |
| formSubmitThanksMessage | No | ||
| shouldAssignContactToTeamMember | No | ||
| shouldSendAlertEmailsToAssignedMember | No | ||
| shouldSkipAssigningContactForExisting | No |