HighLevel: Create Calendar

← Calendars operations · Get started

Operation gohighlevel.create_calendar

Provider route: POST /calendars/. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["calendars"]["createCalendar"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.calendars.createCalendar(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.calendars.create_calendar(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	Model	Required within parent	Expand Create Calendar — request body — body

Referenced models: Create Calendar — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Get Calendar — response body

Referenced models: Get Calendar — response body

Schemas

13 more schemas are linked from the tables above, on the schema pages.

Create Calendar — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
alertEmail	string	Optional
allowBookingAfter	number	Optional	Minimum scheduling notice for events
allowBookingAfterUnit	string	Optional	Unit for minimum scheduling notice One of: hours, days, weeks, months, mins
allowBookingFor	number	Optional	Minimum number of days/weeks/months for which to allow booking events
allowBookingForUnit	string	Optional	Unit for controlling the duration for which booking would be allowed for One of: days, weeks, months
allowCancellation	boolean	Optional	Default: true
allowReschedule	boolean	Optional	Default: true
appoinmentPerDay	number	Optional	Number of appointments that can be booked for a given day
appoinmentPerSlot	number	Optional	Maximum bookings per slot (per user). Maximum seats per slot in case of Class Booking Calendar. Default: 1
autoConfirm	boolean	Optional	Default: true
availabilities	array	Optional	While we will support this property for backward compatibility, it is recommended to use 'Availability' APIs instead.
availabilities[]	Model	Each item	Expand Create Calendar — request body — body availabilities item
availabilityType	number	Optional	While we will support this property for backward compatibility, it is not required anymore. One of: 0, 1
calendarCoverImage	string	Optional
calendarType	string	Optional	One of: round_robin, event, class_booking, collective, service_booking, personal
consentLabel	string	Optional
description	string	Optional
enableRecurring	boolean	Optional	Enable recurring appointments for the calendars. Please note that only one member should be added in the calendar to enable this Default: false
eventColor	string	Optional	Default: #039be5
eventTitle	string	Optional	Default: {{contact.name}}
eventType	string	Optional	Default: RoundRobin_OptimizeForAvailability One of: RoundRobin_OptimizeForAvailability, RoundRobin_OptimizeForEqualDistribution
formId	string	Optional
formSubmitRedirectURL	string	Optional
formSubmitThanksMessage	string	Optional
formSubmitType	string	Optional	Default: ThankYouMessage One of: RedirectURL, ThankYouMessage
googleInvitationEmails	boolean	Optional	Default: false
groupId	string	Optional	Group Id
guestType	string	Optional	One of: count_only, collect_detail
isActive	boolean	Optional	Should the created calendar be active or draft Default: true
isLivePaymentMode	boolean	Optional
locationConfigurations	array	Optional	Meeting location configuration for event calendar
locationConfigurations[]	Model	Each item	Expand Create Calendar — request body — body location Configurations item
locationId	string	Required within parent
lookBusyConfig	JSON	Optional	Look Busy Configuration
lookBusyConfig (allOf 1)	Model	All variants apply	Expand Create Calendar — request body — body look Busy Config Look Busy Percentage, enabled
meetingLocation	string	Optional	🚨 Deprecated! Use `locationConfigurations.location` or `teamMembers[].locationConfigurations.location` instead. Read only: true
name	string	Required within parent
notes	string	Optional
notifications	array	Optional	🚨 Deprecated! Please use 'Calendar Notifications APIs' instead.
notifications[]	Model	Each item	Expand Create Calendar — request body — body notifications item
openHours	array	Optional	While we will support this property for backward compatibility, it is recommended to use 'Availability' APIs instead.
openHours[]	Model	Each item	Expand Create Calendar — request body — body open Hours item
pixelId	string	Optional
preBuffer	number	Optional	Pre-Buffer is additional time that can be added before an appointment, allowing for extra time to get ready
preBufferUnit	string	Optional	Unit for pre-buffer. One of: mins, hours
recurring	Model	Optional	Expand Create Calendar — request body — body recurring
shouldAssignContactToTeamMember	boolean	Optional
shouldSendAlertEmailsToAssignedMember	boolean	Optional
shouldSkipAssigningContactForExisting	boolean	Optional
slotBuffer	number	Optional	Slot-Buffer is additional time that can be added after an appointment, allowing for extra time to wrap up
slotBufferUnit	string	Optional	Unit for slot buffer. One of: mins, hours
slotDuration	number	Optional	This controls the duration of the meeting Default: 30
slotDurationUnit	string	Optional	Unit for slot duration. One of: mins, hours
slotInterval	number	Optional	Slot interval reflects the amount of time the between booking slots that will be shown in the calendar. Default: 30
slotIntervalUnit	string	Optional	Unit for slot interval. One of: mins, hours
slug	string	Optional
stickyContact	boolean	Optional
teamMembers	array	Optional	Team members are required for calendars of type: Round Robin, Collective, Class, Service. Personal calendar must have exactly one team member.
teamMembers[]	Model	Each item	Expand Create Calendar — request body — body team Members item
widgetSlug	string	Optional
widgetType	string	Optional	Calendar widget type. Choose "default" for "neo" and "classic" for "classic" layout. Default: classic One of: default, classic

Referenced models: Create Calendar — request body — body availabilities item, Create Calendar — request body — body notifications item, Create Calendar — request body — body location Configurations item, Create Calendar — request body — body look Busy Config Look Busy Percentage, enabled, Create Calendar — request body — body open Hours item, Create Calendar — request body — body recurring, Create Calendar — request body — body team Members item

Get Calendar — response body

Field	Type	Presence	Description and constraints
$	object	Root
calendar	Model	Required within parent	Expand Get Calendar — response body — calendar

Referenced models: Get Calendar — response body — calendar

Create Calendar — request body — body availabilities item

Field	Type	Presence	Description and constraints
$	object	Root
date	string	Required within parent	Formulate the date string in the format of `<YYYY-MM-DD in local timezone>T00:00:00.000Z`.
deleted	boolean	Optional	Default: false
hours	array	Required within parent
hours[]	Model	Each item	Expand Create Calendar — request body — body open Hours item hours item

Referenced models: Create Calendar — request body — body open Hours item hours item

Create Calendar — request body — body notifications item

Field	Type	Presence	Description and constraints
$	object	Root
selectedUsers	string	Required within parent	Comma separated emails
shouldSendToContact	boolean	Required within parent
shouldSendToGuest	boolean	Required within parent
shouldSendToSelectedUsers	boolean	Required within parent
shouldSendToUser	boolean	Required within parent
type	string	Optional	Calendar Notification Default: email One of: email

Create Calendar — request body — body location Configurations item

Field	Type	Presence	Description and constraints
$	object	Root
kind	string	Required within parent	Type of meeting location. zoom_conference/google_conference/ms_teams_conference is not supported in event calendar type One of: custom, zoom_conference, google_conference, inbound_call, outbound_call, physical, booker, ms_teams_conference
location	string	Optional	Address for meeting location. Not applicable on "zoom_conference", "google_conference" and "ms_teams_conference" kind

Create Calendar — request body — body look Busy Config Look Busy Percentage, enabled

Field	Type	Presence	Description and constraints
$	object	Root
LookBusyPercentage	number	Required within parent	Percentage of slots that will be hidden
enabled	boolean	Required within parent	Apply Look Busy Default: false

Policy, approvals and errors

SDK function policy ID: gohighlevel.create_calendar. Catalog operation: create-calendar. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["calendars.write"]

Pinned headers: {"Version": "v3"}

Official provider source