Overview
Tool name:GHL | Book Time in Calendar | Pro
Use this tool to book an appointment in Go High Level. See Calendar Booking Overview for how availability and booking work across providers.
Provider Settings
| ID | Setting | Type | Required | Default | What it does |
|---|---|---|---|---|---|
100 | calendar_id | string | No | team config | GHL calendar ID. If left blank, the tool falls back to the connected team’s configured GHL calendar. |
Common Settings
| ID | Setting | Type | Required | Default | What it does |
|---|---|---|---|---|---|
0 | Number of Weeks | integer | No | 4 | Weeks to check availability. Tool definition range is 1-8. |
1 | SMS Message | text | No | empty | Custom SMS confirmation message. Written to {{sms.message}}. |
3 | Booking Purpose | text | No | empty | Purpose of the appointment. Written to {{calendar.purpose}}. |
5 | Check Timezone Before Booking | boolean | No | false | Whether the flow verifies the user’s timezone before booking. Written to {{timezone.check_timezone}}. |
6 | Send SMS Confirmation | boolean | No | true | Whether to send an SMS confirmation after booking. Written to {{calendar.sms_flag}}. |
7 | Booking Window Start Offset (Minutes) | integer | No | 15 | Availability starts this many minutes after call start. Older GHL text mentions 30; the current shared default is 15. |
Availability Behavior
GHL availability is loaded from the configured calendar (or the team’s configured GHL calendar whencalendar_id is blank) and converted into the shared calendar format used by the booking flow.
Global Variables Written or Maintained
| Variable | When set | Meaning |
|---|---|---|
{{calendar.purpose}} | Tool entry | Booking purpose configured on the tool. |
{{sms.message}} | Tool entry | Custom SMS confirmation message. |
{{timezone.check_timezone}} | Tool entry | Timezone verification flag. |
{{calendar.sms_flag}} | Tool entry | SMS confirmation flag. |
{{calendar.event_id}} | Availability load | GHL calendar or integration identifier. |
{{calendar.availability_spoken}} | Availability check | Spoken availability response. |
{{calendar.booking_time_raw}} | Slot validation and booking success | Exact selected slot in ISO date-time format. |
{{calendar.booking_time_spoken}} | Booking success | Spoken confirmation time. |
{{calendar.booking_time_written}} | Booking success | Written confirmation time. |
{{calendar.booking_id}} | Booking success | GHL appointment ID. |
{{calendar.booking_link}} | Booking success | Link returned by provider logic when available. Usually empty for GHL. |
Cancellation Behavior
If the user cancels during the same call, the flow uses the GHL cancellation path where supported. A successful cancellation clears the stored booking ID, booking link, and stored booking time values. Output variableresult is boolean true when the booking flow completed successfully.