Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Query Parameters

locationId
string
required

The sub-account this calendar belongs to. It is the only thing that identifies the tenant here, and access is re-checked against it on every call.

Body

application/json

The booking.

calendarId
string
required
Example:

"cal_6b1f2a7c90"

contactId
string
required
Example:

"nct_0123456789abcdef0123"

startTime
required

Epoch milliseconds, or an ISO string. An ISO string with no offset is read in the calendar's own zone.

Example:

"2026-09-24T15:00:00.000Z"

title
string
Example:

"Implant consultation"

assignedUserId
string

Who it belongs to, for a diary that is split by person.

force
boolean

Book past the capacity check. For a person overriding on purpose, never for a retry.

{key}
any

Response

Booked, with the time it actually took.

success
boolean
required
data
object
required

The same shape the GoHighLevel booker answers with.

{key}
any