HighLevel: Create Calendar Resource

← Calendars operations · Get started

Operation gohighlevel.create_calendar_resource

Provider route: POST /calendars/resources/{resourceType}. 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"]["createCalendarResource"]>[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.createCalendarResource(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_resource(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.resourceType	string	Required within parent	One of: equipments, rooms
body	Model	Required within parent	Expand Create Calendar Resource — request body — body

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

Referenced models: Get Calendar Resource — response body

Schemas

Create Calendar Resource — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
calendarIds	array	Required within parent	Service calendar IDs to be mapped with the resource. One equipment can only be mapped with one service calendar. One room can be mapped with multiple service calendars. Maximum items: 100
calendarIds[]	string	Each item
capacity	number	Required within parent	Capacity of the room.
description	string	Required within parent
locationId	string	Required within parent
name	string	Required within parent
outOfService	number	Required within parent	Quantity of the out of service equipment.
quantity	number	Required within parent	Quantity of the equipment.

Get Calendar Resource — response body

Field	Type	Presence	Description and constraints
$	object	Root
calendarIds	array	Required within parent	Calendar IDs
calendarIds[]	string	Each item
capacity	JSON	Optional
capacity (anyOf 1)	number	Alternative	Capacity of the resource
capacity (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
description	string	Optional	Description of the resource
isActive	boolean	Required within parent	Whether the resource is active
locationId	string	Required within parent	Location ID of the resource
name	string	Required within parent	Name of the resource
outOfService	JSON	Optional
outOfService (anyOf 1)	number	Alternative	Indicates if the resource is out of service
outOfService (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
quantity	JSON	Optional
quantity (anyOf 1)	number	Alternative	Quantity of the resource
quantity (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
resourceType	string	Required within parent	Known values: equipments, rooms

Policy, approvals and errors

SDK function policy ID: gohighlevel.create_calendar_resource. Catalog operation: create-calendar-resource. 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/resources.write"]

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

Official provider source