Sign in

v1

latestOpenAPI 3.0.12026-07-2691137122.3 KB
AppointmentService

Manage GHL Appointment

Unified appointment management endpoint for GHL. Supports book, reschedule, cancel, suggest, and availability actions. No X-Api-Key required — org_id comes from the request body.

post/api/v1/ghl/appointments/manage

Request body

action'book' | 'reschedule' | 'cancel' | 'suggest' | 'availability' required

The appointment action to perform

agent_idstring required

UUID of the agent handling the appointment

org_idstring required

UUID of the organization

namestring

Customer full name (required for book)

emailstring

Customer email (required for book if no phone)

phonestring

Customer phone in E.164 format (required for book if no email)

appointment_datetimestring

ISO 8601 datetime for book or reschedule

appointment_idstring

Existing appointment ID (required for cancel and reschedule)

call_session_idstring

Optional call session ID for book

notesstring

Optional notes for the appointment

days_aheadinteger

Days ahead to look for available slots (default: 7, max: 30). Used for suggest and availability.

Response

Successful response

successboolean
messagestring

Natural language message to relay directly to the user