calendars_create_appointment
Create GoHighLevel calendar appointments with required calendar, contact, and start time. Optionally set recurrence, location, and status while respecting free slot validation.
Instructions
Create appointment
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rrule | No | 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. | |
| title | No | Title | |
| address | No | Appointment Address | |
| endTime | No | End Time | |
| toNotify | No | If set to false, the automations will not run | |
| contactId | Yes | Contact Id | |
| startTime | Yes | Start Time | |
| calendarId | Yes | Calendar Id | |
| locationId | No | Location Id Defaults to GHL_LOCATION_ID when omitted. | |
| description | No | Appointment Description | |
| assignedUserId | No | Assigned User Id | |
| ignoreDateRange | No | If set to true, the minimum scheduling notice and date range would be ignored | |
| appointmentStatus | No | ||
| meetingLocationId | No | The unique identifier for the meeting location. - This value can be found in `calendar.locationConfigurations`or `calendar.teamMembers[].locationConfigurations` | |
| meetingLocationType | No | Meeting location type. - If `address` is provided in the request body, the `meetingLocationType` defaults to **custom**. | |
| overrideLocationConfig | No | Flag to override location config - **false** - If only `meetingLocationId` is provided - **true** - If only `meetingLocationType` is provided | |
| ignoreFreeSlotValidation | No | If true the time slot validation would be avoided for any appointment creation (even the ignoreDateRange) |