HighLevel: Create appointment

← Calendars operations · Get started

Operation gohighlevel.create_appointment

Provider route: POST /calendars/events/appointments. 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"]["createAppointment"]>[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.createAppointment(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_appointment(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 appointment — request body — body

Referenced models: Create appointment — 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 Create appointment — response body

Referenced models: Create appointment — response body

Schemas

Create appointment — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
address	string	Optional	Appointment Address
appointmentStatus	string	Optional	One of: new, confirmed, cancelled, showed, noshow, invalid, completed, active
assignedUserId	string	Optional	Assigned User Id
calendarId	string	Required within parent	Calendar Id
contactId	string	Required within parent	Contact Id
description	string	Optional	Appointment Description
endTime	string	Optional	End Time
ignoreDateRange	boolean	Optional	If set to true, the minimum scheduling notice and date range would be ignored
ignoreFreeSlotValidation	boolean	Optional	If true the time slot validation would be avoided for any appointment creation (even the ignoreDateRange)
locationId	string	Required within parent	Location Id
meetingLocationId	string	Optional	The unique identifier for the meeting location. - This value can be found in `calendar.locationConfigurations`or `calendar.teamMembers[].locationConfigurations` Default: default
meetingLocationType	string	Optional	Meeting location type. - If `address` is provided in the request body, the `meetingLocationType` defaults to **custom**. One of: custom, zoom, gmeet, phone, address, ms_teams, google
overrideLocationConfig	boolean	Optional	Flag to override location config - **false** - If only `meetingLocationId` is provided - **true** - If only `meetingLocationType` is provided
rrule	string	Optional	RRULE as per the iCalendar (RFC 5545) specification for recurring events. DTSTART is not required, instance ids are calculated on the basis of startTime of the event. The rrule only be applied if ignoreFreeSlotValidation is true.
startTime	string	Required within parent	Start Time
title	string	Optional	Title
toNotify	boolean	Optional	If set to false, the automations will not run. Defaults to true Default: true

Create appointment — response body

Field	Type	Presence	Description and constraints
$	object	Root
address	string	Optional	Appointment Address
appointmentStatus	string	Optional	Known values: new, confirmed, cancelled, showed, noshow, invalid, active, completed
assignedUserId	string	Optional	Assigned User Id
calendarId	string	Required within parent	Calendar Id
contactId	string	Required within parent	Contact Id
dateAdded	string	Required within parent	Date Added
dateUpdated	string	Required within parent	Date Updated
endTime	string	Optional	End Time
id	string	Required within parent	Id
isRecurring	boolean	Optional	true if the event is recurring otherwise false
locationId	string	Required within parent	Location Id
meetingLocationType	string	Optional	Meeting Location Type Default: default
rrule	string	Optional	RRULE as per the iCalendar (RFC 5545) specification for recurring events
startTime	string	Optional	Start Time
title	string	Optional	Title

Policy, approvals and errors

SDK function policy ID: gohighlevel.create_appointment. Catalog operation: create-appointment. 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/events.write"]

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

Official provider source