Update calendar - Automate.ax

highlevel.updateCalendar updates one calendar by ID.

automations/highlevel-update-calendar.automation.ts

import { automation, markSignificant } from "automate.ax"
import { highlevel } from "automate.ax/highlevel"

export default automation("Update calendar", () => {
  markSignificant(
    highlevel.updateCalendar({
      calendarId: "ocQHyuzHvysMo5N5VsXc",
    }),
  )
})

Input

Field	Type	Required	Description
`calendarId`	`string`	Yes	HighLevel calendar id value.
`notifications`	`object[]`	No	Deprecated. Please use ‘Calendar Notifications APIs’ instead.
`groupId`	`string`	No	Group Id
`teamMembers`	`object[]`	No	Team members are required for calendars of type: Round Robin, Collective, Class, Service. Personal calendar must have exactly one team member.
`eventType`	`RoundRobin_OptimizeForAvailability \| RoundRobin_OptimizeForEqualDistribution`	No	HighLevel event type value.
`name`	`string`	No	HighLevel name value.
`description`	`string`	No	HighLevel description value.
`slug`	`string`	No	HighLevel slug value.
`widgetSlug`	`string`	No	HighLevel widget slug value.
`widgetType`	`default \| classic`	No	Calendar widget type. Choose “default” for the new layout and “classic” for “classic” layout.
`eventTitle`	`string`	No	HighLevel event title value.
`eventColor`	`string`	No	HighLevel event color value.
`locationConfigurations`	`object[]`	No	Meeting location configuration for event calendar
`meetingLocation`	`string`	No	Deprecated. Use `locationConfigurations.location` or `teamMembers[].locationConfigurations.location` instead.
`slotDuration`	`number`	No	This controls the duration of the meeting
`slotDurationUnit`	`mins \| hours`	No	Unit for slot duration.
`preBufferUnit`	`mins \| hours`	No	Unit for pre-buffer.
`slotInterval`	`number`	No	Slot interval reflects the amount of time the between booking slots that will be shown in the calendar.
`slotIntervalUnit`	`mins \| hours`	No	Unit for slot interval.
`slotBuffer`	`number`	No	Slot-Buffer is additional time that can be added after an appointment, allowing for extra time to wrap up
`preBuffer`	`number`	No	Pre-Buffer is additional time that can be added before an appointment, allowing for extra time to get ready
`appoinmentPerSlot`	`number`	No	Maximum appointments per slot.
`appoinmentPerDay`	`number`	No	Number of appointments that can be booked for a given day
`allowBookingAfter`	`number`	No	Minimum scheduling notice for events
`allowBookingAfterUnit`	`hours \| days \| weeks \| months`	No	Unit for minimum scheduling notice
`allowBookingFor`	`number`	No	Minimum number of days/weeks/months for which to allow booking events
`allowBookingForUnit`	`days \| weeks \| months`	No	Unit for controlling the duration for which booking would be allowed for
`openHours`	`object[]`	No	Standard availability hours.
`enableRecurring`	`boolean`	No	Enable recurring appointments for the calendars. Please note that only one member should be added in the calendar to enable this
`recurring`	`object`	No	HighLevel recurring value.
`formId`	`string`	No	HighLevel form id value.
`stickyContact`	`boolean`	No	HighLevel sticky contact value.
`isLivePaymentMode`	`boolean`	No	HighLevel is live payment mode value.
`autoConfirm`	`boolean`	No	HighLevel auto confirm value.
`shouldSendAlertEmailsToAssignedMember`	`boolean`	No	HighLevel should send alert emails to assigned member value.
`alertEmail`	`string`	No	HighLevel alert email value.
`googleInvitationEmails`	`boolean`	No	HighLevel google invitation emails value.
`allowReschedule`	`boolean`	No	HighLevel allow reschedule value.
`allowCancellation`	`boolean`	No	HighLevel allow cancellation value.
`shouldAssignContactToTeamMember`	`boolean`	No	HighLevel should assign contact to team member value.
`shouldSkipAssigningContactForExisting`	`boolean`	No	HighLevel should skip assigning contact for existing value.
`notes`	`string`	No	HighLevel notes value.
`pixelId`	`string`	No	HighLevel pixel id value.
`formSubmitType`	`RedirectURL \| ThankYouMessage`	No	HighLevel form submit type value.
`formSubmitRedirectURL`	`string`	No	Form submission redirect URL.
`formSubmitThanksMessage`	`string`	No	HighLevel form submit thanks message value.
`availabilityType`	`0 \| 1`	No	Determines which availability type to consider: - 1: Only custom availabilities will be used. - 0: Only open hours will be used. - null: Both the custom availabilities and open hours will be considered.
`availabilities`	`object[]`	No	This is only to set the custom availability. For standard availability, use the standard availability hours
`guestType`	`count_only \| collect_detail`	No	HighLevel guest type value.
`consentLabel`	`string`	No	HighLevel consent label value.
`calendarCoverImage`	`string`	No	HighLevel calendar cover image value.
`lookBusyConfig`	`JSON value`	No	Look Busy Configuration
`isActive`	`boolean`	No	HighLevel is active value.

Automate.ax supplies the connected sub-account’s location ID. Optional second argument { account } selects a named HighLevel binding.

Output

Field	Type	Required	Description
`calendar`	`object`	Yes	HighLevel calendar value.

This action calls PUT /calendars/{calendarId} with HighLevel API version 2021-04-15 and requires calendars.write. HighLevel validation and permission errors fail the action. Rate limits honor the provider’s retry timing.