HighLevel: Calendars schemas

← Calendars operations · All schemas

Create Block Slot — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
assignedUserId	string	Optional	Either calendarId or assignedUserId can be set, not both.
calendarId	string	Required within parent	Either calendarId or assignedUserId can be set, not both.
endTime	string	Optional	End Time
locationId	string	Required within parent	Location Id
startTime	string	Optional	Start Time
title	string	Optional	Title

Create Block Slot — response body

Field	Type	Presence	Description and constraints
$	object	Root
assignedUserId	string	Optional	Assigned User Id
calendarId	string	Optional	Calendar id
endTime	object	Required within parent	End Time
id	string	Required within parent	Id
locationId	string	Required within parent	Location Id
startTime	object	Required within parent	Start Time
title	string	Required within parent	Title

Create Calendar Group — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
description	string	Required within parent
isActive	boolean	Optional
locationId	string	Required within parent
name	string	Required within parent
slug	string	Required within parent

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.

Create Calendar — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
alertEmail	string	Optional
allowBookingAfter	number	Optional	Minimum scheduling notice for events
allowBookingAfterUnit	string	Optional	Unit for minimum scheduling notice One of: hours, days, weeks, months, mins
allowBookingFor	number	Optional	Minimum number of days/weeks/months for which to allow booking events
allowBookingForUnit	string	Optional	Unit for controlling the duration for which booking would be allowed for One of: days, weeks, months
allowCancellation	boolean	Optional	Default: true
allowReschedule	boolean	Optional	Default: true
appoinmentPerDay	number	Optional	Number of appointments that can be booked for a given day
appoinmentPerSlot	number	Optional	Maximum bookings per slot (per user). Maximum seats per slot in case of Class Booking Calendar. Default: 1
autoConfirm	boolean	Optional	Default: true
availabilities	array	Optional	While we will support this property for backward compatibility, it is recommended to use 'Availability' APIs instead.
availabilities[]	Model	Each item	Expand Create Calendar — request body — body availabilities item
availabilityType	number	Optional	While we will support this property for backward compatibility, it is not required anymore. One of: 0, 1
calendarCoverImage	string	Optional
calendarType	string	Optional	One of: round_robin, event, class_booking, collective, service_booking, personal
consentLabel	string	Optional
description	string	Optional
enableRecurring	boolean	Optional	Enable recurring appointments for the calendars. Please note that only one member should be added in the calendar to enable this Default: false
eventColor	string	Optional	Default: #039be5
eventTitle	string	Optional	Default: {{contact.name}}
eventType	string	Optional	Default: RoundRobin_OptimizeForAvailability One of: RoundRobin_OptimizeForAvailability, RoundRobin_OptimizeForEqualDistribution
formId	string	Optional
formSubmitRedirectURL	string	Optional
formSubmitThanksMessage	string	Optional
formSubmitType	string	Optional	Default: ThankYouMessage One of: RedirectURL, ThankYouMessage
googleInvitationEmails	boolean	Optional	Default: false
groupId	string	Optional	Group Id
guestType	string	Optional	One of: count_only, collect_detail
isActive	boolean	Optional	Should the created calendar be active or draft Default: true
isLivePaymentMode	boolean	Optional
locationConfigurations	array	Optional	Meeting location configuration for event calendar
locationConfigurations[]	Model	Each item	Expand Create Calendar — request body — body location Configurations item
locationId	string	Required within parent
lookBusyConfig	JSON	Optional	Look Busy Configuration
lookBusyConfig (allOf 1)	Model	All variants apply	Expand Create Calendar — request body — body look Busy Config Look Busy Percentage, enabled
meetingLocation	string	Optional	🚨 Deprecated! Use `locationConfigurations.location` or `teamMembers[].locationConfigurations.location` instead. Read only: true
name	string	Required within parent
notes	string	Optional
notifications	array	Optional	🚨 Deprecated! Please use 'Calendar Notifications APIs' instead.
notifications[]	Model	Each item	Expand Create Calendar — request body — body notifications item
openHours	array	Optional	While we will support this property for backward compatibility, it is recommended to use 'Availability' APIs instead.
openHours[]	Model	Each item	Expand Create Calendar — request body — body open Hours item
pixelId	string	Optional
preBuffer	number	Optional	Pre-Buffer is additional time that can be added before an appointment, allowing for extra time to get ready
preBufferUnit	string	Optional	Unit for pre-buffer. One of: mins, hours
recurring	Model	Optional	Expand Create Calendar — request body — body recurring
shouldAssignContactToTeamMember	boolean	Optional
shouldSendAlertEmailsToAssignedMember	boolean	Optional
shouldSkipAssigningContactForExisting	boolean	Optional
slotBuffer	number	Optional	Slot-Buffer is additional time that can be added after an appointment, allowing for extra time to wrap up
slotBufferUnit	string	Optional	Unit for slot buffer. One of: mins, hours
slotDuration	number	Optional	This controls the duration of the meeting Default: 30
slotDurationUnit	string	Optional	Unit for slot duration. One of: mins, hours
slotInterval	number	Optional	Slot interval reflects the amount of time the between booking slots that will be shown in the calendar. Default: 30
slotIntervalUnit	string	Optional	Unit for slot interval. One of: mins, hours
slug	string	Optional
stickyContact	boolean	Optional
teamMembers	array	Optional	Team members are required for calendars of type: Round Robin, Collective, Class, Service. Personal calendar must have exactly one team member.
teamMembers[]	Model	Each item	Expand Create Calendar — request body — body team Members item
widgetSlug	string	Optional
widgetType	string	Optional	Calendar widget type. Choose "default" for "neo" and "classic" for "classic" layout. Default: classic One of: default, classic

Referenced models: Create Calendar — request body — body availabilities item, Create Calendar — request body — body notifications item, Create Calendar — request body — body location Configurations item, Create Calendar — request body — body look Busy Config Look Busy Percentage, enabled, Create Calendar — request body — body open Hours item, Create Calendar — request body — body recurring, Create Calendar — request body — body team Members item

Create Calendar — request body — body availabilities item

Field	Type	Presence	Description and constraints
$	object	Root
date	string	Required within parent	Formulate the date string in the format of `<YYYY-MM-DD in local timezone>T00:00:00.000Z`.
deleted	boolean	Optional	Default: false
hours	array	Required within parent
hours[]	Model	Each item	Expand Create Calendar — request body — body open Hours item hours item

Referenced models: Create Calendar — request body — body open Hours item hours item

Create Calendar — request body — body location Configurations item

Field	Type	Presence	Description and constraints
$	object	Root
kind	string	Required within parent	Type of meeting location. zoom_conference/google_conference/ms_teams_conference is not supported in event calendar type One of: custom, zoom_conference, google_conference, inbound_call, outbound_call, physical, booker, ms_teams_conference
location	string	Optional	Address for meeting location. Not applicable on "zoom_conference", "google_conference" and "ms_teams_conference" kind

Create Calendar — request body — body look Busy Config Look Busy Percentage, enabled

Field	Type	Presence	Description and constraints
$	object	Root
LookBusyPercentage	number	Required within parent	Percentage of slots that will be hidden
enabled	boolean	Required within parent	Apply Look Busy Default: false

Create Calendar — request body — body notifications item

Field	Type	Presence	Description and constraints
$	object	Root
selectedUsers	string	Required within parent	Comma separated emails
shouldSendToContact	boolean	Required within parent
shouldSendToGuest	boolean	Required within parent
shouldSendToSelectedUsers	boolean	Required within parent
shouldSendToUser	boolean	Required within parent
type	string	Optional	Calendar Notification Default: email One of: email

Create Calendar — request body — body open Hours item

Field	Type	Presence	Description and constraints
$	object	Root
daysOfTheWeek	array	Required within parent
daysOfTheWeek[]	number	Each item	Maximum: 6 Minimum: 0
hours	array	Required within parent
hours[]	Model	Each item	Expand Create Calendar — request body — body open Hours item hours item

Referenced models: Create Calendar — request body — body open Hours item hours item

Create Calendar — request body — body open Hours item hours item

Field	Type	Presence	Description and constraints
$	object	Root
closeHour	number	Required within parent	Maximum: 23 Minimum: 0
closeMinute	number	Required within parent	Maximum: 60 Minimum: 0
openHour	number	Required within parent	Maximum: 23 Minimum: 0
openMinute	number	Required within parent	Maximum: 60 Minimum: 0

Create Calendar — request body — body recurring

Field	Type	Presence	Description and constraints
$	object	Root
bookingOption	string	Optional	This setting contols what to do incase a recurring slot is unavailable One of: skip, continue, book_next
bookingOverlapDefaultStatus	string	Optional	This setting contols what to do incase a recurring slot is unavailable One of: confirmed, new
count	number	Optional	Number of recurrences Maximum: 24
freq	string	Optional	One of: DAILY, WEEKLY, MONTHLY

Create Calendar — request body — body team Members item

Field	Type	Presence	Description and constraints
$	object	Root
isPrimary	boolean	Optional	Marks a user as primary. This property is required in case of collective booking calendars. Only one user can be primary.
locationConfigurations	array	Optional	Meeting location configuration for event calendar. - *Multiple locations are allowed only when one team member is selected.* - *For **Class booking** and **Collective** calendars, only one location configuration is allowed for each team member.*
locationConfigurations[]	Model	Each item	Expand Create Calendar — request body — body location Configurations item
meetingLocation	string	Optional	🚨 Deprecated! Use `locationConfigurations.location` instead. Read only: true
meetingLocationType	string	Optional	🚨 Deprecated! Use `locationConfigurations.kind` instead. Default: custom One of: custom, zoom, gmeet, phone, address, teams, booker Read only: true
priority	number	Optional	Default: 0.5 One of: 0, 0.5, 1
userId	string	Required within parent

Referenced models: Create Calendar — request body — body location Configurations item

Create Note — calendars create Appointment Note — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
body	string	Required within parent	Note body Maximum length: 5000
userId	string	Optional

Create Note — calendars create Appointment Note — response body

Field	Type	Presence	Description and constraints
$	object	Root
note	Model	Optional	Expand Create Note — calendars create Appointment Note — response body — note

Referenced models: Create Note — calendars create Appointment Note — response body — note

Create Note — calendars create Appointment Note — response body — note

Field	Type	Presence	Description and constraints
$	object	Root
body	string	Optional
contactId	string	Optional
createdBy	Model	Optional	Expand Create Note — calendars create Appointment Note — response body — note created By
dateAdded	string	Optional
id	string	Optional
userId	string	Optional

Referenced models: Create Note — calendars create Appointment Note — response body — note created By

Create Note — calendars create Appointment Note — response body — note created By

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Optional
name	string	Optional

Create Service Booking — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
contactId	string	Required within parent	Contact ID
endTime	string	Required within parent	End Time
locationId	string	Required within parent	Location ID
meetingLocation	string	Optional	Meeting Location (If service location is an ask the booker, then the meeting location is required)
serviceLocationId	string	Optional	Service Location ID (If not provided, then the default service location will be used)
services	array	Required within parent	Services
services[]	Model	Each item	Expand Create Service Booking — request body — body services item
startTime	string	Required within parent	Start Time
status	string	Optional	Status. (If not provided, the status configured in Service Global Settings will be used.) One of: confirmed, new
timezone	string	Required within parent	Timezone
title	string	Optional	Service Booking Title

Referenced models: Create Service Booking — request body — body services item

Create Service Booking — request body — body services item

Field	Type	Presence	Description and constraints
$	object	Root
addOns	array	Optional	Add-ons
addOns[]	Model	Each item	Expand Create Service Booking — request body — body services item add Ons item
id	string	Required within parent	Service ID
position	number	Optional	Position
staffId	string	Optional	Staff ID

Referenced models: Create Service Booking — request body — body services item add Ons item

Create Service Booking — request body — body services item add Ons item

Field	Type	Presence	Description and constraints
$	object	Root
duration	number	Optional	Add-on duration (in minutes)
id	string	Required within parent	Add-on ID
quantity	number	Optional	Add-on quantity

Create Service Booking — response body

Field	Type	Presence	Description and constraints
$	object	Root
bookingId	string	Required within parent	Booking ID
contactId	string	Required within parent	Contact ID
createdBy	JSON	Required within parent	Booking booked by metadata
createdBy (allOf 1)	Model	All variants apply	Expand Create Service Booking — response body — created By source, user Id
dateAdded	string	Required within parent	Date Added
dateUpdated	string	Required within parent	Date Updated
deleted	boolean	Required within parent	Tells if the booking is deleted
endTime	string	Required within parent	End Time
locationId	string	Required within parent	Location ID
meetingLocation	string	Optional	Meeting Location (If service location is an ask the booker, then the meeting location is used for the booking)
messages	array	Optional	Optional informative or warning messages (e.g. meeting location ignored for non-ask-booker locations)
messages[]	array	Each item
serviceLocationId	string	Required within parent	Service Location ID
services	array	Required within parent	Services
services[]	Model	Each item	Expand Create Service Booking — response body — services item
startTime	string	Required within parent	Start Time
status	string	Required within parent	Status
timezone	string	Required within parent	Timezone
title	string	Required within parent	Service Booking Title

Referenced models: Create Service Booking — response body — created By source, user Id, Create Service Booking — response body — services item

Create Service Booking — response body — created By source, user Id

Field	Type	Presence	Description and constraints
$	object	Root
source	string	Required within parent	The source of the appointment
userId	string	Optional	The ID of the user who created or updated the appointment

Create Service Booking — response body — services item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	Service ID
serviceAddOns	array	Optional	Service Add-ons
serviceAddOns[]	Model	Each item	Expand Create Service Booking — response body — services item service Add Ons item
serviceCategoryId	string	Required within parent	Service Category ID
serviceEndTime	string	Required within parent	Service End Time
serviceResources	array	Optional	Service Resources
serviceResources[]	Model	Each item	Expand Create Service Booking — response body — services item service Resources item
serviceStaffId	string	Required within parent	Service Staff ID
serviceStartTime	string	Required within parent	Service Start Time

Referenced models: Create Service Booking — response body — services item service Add Ons item, Create Service Booking — response body — services item service Resources item

Create Service Booking — response body — services item service Add Ons item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	Add-on ID
quantity	JSON	Optional
quantity (anyOf 1)	number	Alternative	Add-on quantity
quantity (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create Service Booking — response body — services item service Resources item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	Resource ID

Create Service Location — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
address	string	Optional	Use a full street address when locationType is offline. Use a user-facing label when locationType is ask_booker.
coverImage	string	Optional	URL of the cover image for this service location
locationId	string	Required within parent	Location ID
locationType	string	Optional	Location type One of: offline, ask_booker
name	string	Required within parent	Location name
phone	string	Optional	Phone number
slug	string	Required within parent	URL-friendly slug identifier

Create Service Location — response body

Field	Type	Presence	Description and constraints
$	object	Root
address	string	Optional	Use a full street address when locationType is offline. Use a user-facing label when locationType is ask_booker.
coverImage	string	Optional	URL of the cover image displayed for this location
id	string	Required within parent	Service Location ID
isActive	boolean	Optional	Whether location is active Default: true
isPrivate	boolean	Optional	Whether location is private (not shown publicly) Default: false
locationId	string	Required within parent	Location ID
locationType	string	Optional	Location type Known values: offline, ask_booker
name	string	Required within parent	Location name
phone	string	Optional	Contact phone number for the service location
slug	string	Required within parent	Unique URL-friendly identifier for the service location

Create Service — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
coverImage	string	Optional	Service cover image URL
description	string	Optional	Service description
eventColor	string	Optional	Service event color (hex)
formId	string	Optional	Custom form ID (will be used to display the custom form on the booking page, if only one service is selected)
isPrivate	boolean	Optional	Whether service is private (not shown publicly)
locationId	string	Required within parent	Location ID
name	string	Required within parent	Service name
payment	JSON	Optional	Payment details (default amount is 0, currency configured in Service Global Settings is used.)
payment (allOf 1)	Model	All variants apply	Expand Create Service — request body — body / payment / depositType: percentage, amount
postBuffer	number	Optional	Post-buffer: Additional time that can be added after an appointment, allowing for extra time to wrap up
postBufferUnit	string	Optional	Post-buffer unit One of: mins, hours
preBuffer	number	Optional	Pre-Buffer is additional time that can be added before an appointment, allowing for extra time to get ready
preBufferUnit	string	Optional	Pre-buffer unit One of: mins, hours
serviceCategoryId	string	Optional	Service category ID (uses default category if not provided)
serviceDuration	number	Optional	This controls the duration of the appointment
serviceDurationUnit	string	Optional	Duration unit One of: mins, hours
slug	string	Required within parent	Unique URL-friendly identifier
staff	array	Required within parent	Assigned staff members (at least one required)
staff[]	Model	Each item	Expand Create Service — request body — body staff item
variations	array	Optional	Service variations (pass empty array for no variations)
variations[]	Model	Each item	Expand Create Service — request body — body variations item

Referenced models: Create Service — request body — body variations item, Create Service — request body — body staff item, Create Service — request body — body / payment / depositType: percentage, amount

Create Service — request body — body / payment / depositType: percentage, amount

Field	Type	Presence	Description and constraints
$	object	Root
amount	number	Optional	Service price
deposit	number	Optional	Deposit amount or percentage value
depositType	string	Optional	Deposit type One of: percentage, amount

Create Service — request body — body staff item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	Staff ID

Create Service — request body — body variations item

Field	Type	Presence	Description and constraints
$	object	Root
name	string	Required within parent	Variation name
payment	JSON	Optional	Payment details
payment (allOf 1)	Model	All variants apply	Expand Create Service — request body — body / payment / depositType: percentage, amount
postBuffer	number	Optional	Post-buffer: Additional time that can be added after an appointment, allowing for extra time to wrap up
postBufferUnit	string	Optional	Post-buffer unit One of: mins, hours
preBuffer	number	Optional	Pre-Buffer is additional time that can be added before an appointment, allowing for extra time to get ready
preBufferUnit	string	Optional	Pre-buffer unit One of: mins, hours
serviceDuration	number	Optional	This controls the duration of the appointment
serviceDurationUnit	string	Optional	Duration unit One of: mins, hours

Referenced models: Create Service — request body — body / payment / depositType: percentage, amount

Create Service — response body

Field	Type	Presence	Description and constraints
$	object	Root
service	JSON	Required within parent	Service details
service (allOf 1)	Model	All variants apply	Expand Get Services — response body — services item

Referenced models: Get Services — response body — services item

Create appointment — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
address	string	Optional	Appointment Address
appointmentStatus	string	Optional	One of: new, confirmed, cancelled, showed, noshow, invalid, completed, active
assignedUserId	string	Optional	Assigned User Id
calendarId	string	Required within parent	Calendar Id
contactId	string	Required within parent	Contact Id
description	string	Optional	Appointment Description
endTime	string	Optional	End Time
ignoreDateRange	boolean	Optional	If set to true, the minimum scheduling notice and date range would be ignored
ignoreFreeSlotValidation	boolean	Optional	If true the time slot validation would be avoided for any appointment creation (even the ignoreDateRange)
locationId	string	Required within parent	Location Id
meetingLocationId	string	Optional	The unique identifier for the meeting location. - This value can be found in `calendar.locationConfigurations`or `calendar.teamMembers[].locationConfigurations` Default: default
meetingLocationType	string	Optional	Meeting location type. - If `address` is provided in the request body, the `meetingLocationType` defaults to **custom**. One of: custom, zoom, gmeet, phone, address, ms_teams, google
overrideLocationConfig	boolean	Optional	Flag to override location config - **false** - If only `meetingLocationId` is provided - **true** - If only `meetingLocationType` is provided
rrule	string	Optional	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.
startTime	string	Required within parent	Start Time
title	string	Optional	Title
toNotify	boolean	Optional	If set to false, the automations will not run. Defaults to true Default: true

Create appointment — response body

Field	Type	Presence	Description and constraints
$	object	Root
address	string	Optional	Appointment Address
appointmentStatus	string	Optional	Known values: new, confirmed, cancelled, showed, noshow, invalid, active, completed
assignedUserId	string	Optional	Assigned User Id
calendarId	string	Required within parent	Calendar Id
contactId	string	Required within parent	Contact Id
dateAdded	string	Required within parent	Date Added
dateUpdated	string	Required within parent	Date Updated
endTime	string	Optional	End Time
id	string	Required within parent	Id
isRecurring	boolean	Optional	true if the event is recurring otherwise false
locationId	string	Required within parent	Location Id
meetingLocationType	string	Optional	Meeting Location Type Default: default
rrule	string	Optional	RRULE as per the iCalendar (RFC 5545) specification for recurring events
startTime	string	Optional	Start Time
title	string	Optional	Title

Create event calendar availability schedule — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
rules	array	Required within parent	Schedule rules defining when the schedule is active
rules[]	Model	Each item	Expand Create user availability schedule — request body — body rules item
timezone	string	Required within parent	Timezone for the schedule (IANA timezone identifier) Pattern: ^[A-Za-z_]+/[A-Za-z_]+$

Referenced models: Create user availability schedule — request body — body rules item

Create notification — request body — body item

Field	Type	Presence	Description and constraints
$	object	Root
additionalEmailIds	array	Optional	Additional email addresses to receive notifications.
additionalEmailIds[]	string	Each item
additionalPhoneNumbers	array	Optional	Additional phone numbers to receive notifications.
additionalPhoneNumbers[]	string	Each item
afterTime	array	Optional	Specifies the time after which the follow-up notification should be sent. This is not required for other notification types.
afterTime[]	Model	Each item	Expand Update notification — request body — body after Time item
beforeTime	array	Optional	Specifies the time before which the reminder notification should be sent. This is not required for other notification types.
beforeTime[]	Model	Each item	Expand Update notification — request body — body after Time item
body	string	Optional	Body for email notification. Not necessary for in-App notification
channel	string	Required within parent	Notification channel One of: email, inApp, sms, whatsapp
fromAddress	string	Optional	from address for email notification
fromName	string	Optional	from name for email/sms notification
fromNumber	string	Optional	from number for sms notification
isActive	boolean	Optional	Is the notification active Default: true
notificationType	string	Required within parent	Notification type One of: booked, confirmation, cancellation, reminder, followup, reschedule
receiverType	string	Required within parent	notification recipient type One of: contact, guest, assignedUser, emails, phoneNumbers, business
selectedUsers	array	Optional	Selected users for in-App and business email notifications. Supports user IDs and special keyword "sub_account_admin"
selectedUsers[]	string	Each item
subject	string	Optional	Subject for email notification. Not necessary for in-App notification
templateId	string	Optional	Template ID for email notification. Not necessary for in-App notification

Referenced models: Update notification — request body — body after Time item

Create user availability schedule — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
calendarIds	array	Optional	Calendar IDs associated with the schedule
calendarIds[]	string	Each item
locationId	string	Required within parent	Location ID where this schedule applies
name	string	Required within parent	Human-readable name for the schedule
rules	array	Optional	Schedule rules defining when the schedule is active
rules[]	Model	Each item	Expand Create user availability schedule — request body — body rules item
timezone	string	Required within parent	Timezone for the schedule (IANA timezone identifier) Pattern: ^[A-Za-z_]+/[A-Za-z_]+$
userId	string	Required within parent	User ID associated with the schedule

Referenced models: Create user availability schedule — request body — body rules item

Create user availability schedule — request body — body rules item

Field	Type	Presence	Description and constraints
$	object	Root
date	string	Optional	Specific date in YYYY-MM-DD format (only for date-type rules) Pattern: ^\d{4}-\d{2}-\d{2}$
day	string	Optional	Day of week (only for weekday-type rules) One of: sunday, monday, tuesday, wednesday, thursday, friday, saturday
intervals	array	Required within parent	Time intervals for the rule (e.g., 9 AM to 5 PM)
intervals[]	Model	Each item	Expand Create user availability schedule — request body — body rules item intervals item
type	string	Required within parent	Type of schedule rule - weekday (recurring) or date (specific date) One of: wday, date

Referenced models: Create user availability schedule — request body — body rules item intervals item

Create user availability schedule — request body — body rules item intervals item

Field	Type	Presence	Description and constraints
$	object	Root
from	string	Required within parent	Start time in HH:MM format (24-hour format) Pattern: ^([01]?[0-9]|2[0-3]):[0-5][0-9]$
to	string	Required within parent	End time in HH:MM format (24-hour format) Pattern: ^([01]?[0-9]|2[0-3]):[0-5][0-9]$

Delete Calendar — response body

Field	Type	Presence	Description and constraints
$	object	Root
success	boolean	Required within parent	Success

Delete Event — request body — body

Field	Type	Presence	Description and constraints
$	object	Root

Delete Event — response body

Field	Type	Presence	Description and constraints
$	object	Root
succeeded	boolean	Optional

Delete Group — response body

Field	Type	Presence	Description and constraints
$	object	Root
success	boolean	Optional	Success

Delete Note — calendars delete Appointment Note — response body

Field	Type	Presence	Description and constraints
$	object	Root
success	boolean	Optional

Delete Notification — response body

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Required within parent	Result of delete/update operation

Delete Service Booking — response body

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Required within parent	Response message
success	boolean	Required within parent	Indicates if the deletion was successful

Delete Service — response body

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Optional	Success message
success	boolean	Required within parent	Success

Disable Group — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
isActive	boolean	Required within parent	Is Active?

Get Appointment — response body

Field	Type	Presence	Description and constraints
$	object	Root
event	Model	Optional	Expand Get Appointment — response body — event

Referenced models: Get Appointment — response body — event

Get Appointment — response body — event

Field	Type	Presence	Description and constraints
$	object	Root
address	string	Optional	Calendar Event address
appointmentStatus	string	Required within parent	Appointment Status
assignedResources	array	Optional	Ids of associated resources rooms and/or equipments
assignedResources[]	string	Each item
assignedUserId	string	Required within parent	AssignedUser - the primary owner of an appointment
calendarId	string	Required within parent	Calendar ID
contactId	string	Required within parent	Contact ID
createdBy	JSON	Optional	Appointment booked by metadata
createdBy (allOf 1)	Model	All variants apply	Expand Create Service Booking — response body — created By source, user Id
dateAdded	object	Required within parent	Date Added
dateUpdated	object	Required within parent	Date Updated
deleted	boolean	Optional	Tells if a calendar event has been deleted
description	string	Optional	Description
endTime	object	Required within parent	End Time
groupId	string	Required within parent	Group ID
id	string	Required within parent	Event Id or Instance id for a recurring event
isRecurring	boolean	Optional	true if the event is recurring otherwise false
locationId	string	Required within parent	Location ID
masterEventId	string	Optional	Master event id for a recurring instance
notes	string	Optional	Notes
rrule	string	Optional	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.
startTime	object	Required within parent	Start Time
title	string	Required within parent	Calendar Event title
users	array	Required within parent	Users - the secondary owners of an appointment.
users[]	string	Each item

Referenced models: Create Service Booking — response body — created By source, user Id

Get Blocked Slots — response body

Field	Type	Presence	Description and constraints
$	object	Root
events	array	Optional
events[]	Model	Each item	Expand Get Appointment — response body — event

Referenced models: Get Appointment — response body — event

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

Get Calendar — response body

Field	Type	Presence	Description and constraints
$	object	Root
calendar	Model	Required within parent	Expand Get Calendar — response body — calendar

Referenced models: Get Calendar — response body — calendar

Get Calendar — response body — calendar

Field	Type	Presence	Description and constraints
$	object	Root
alertEmail	string	Optional
allowBookingAfter	JSON	Optional
allowBookingAfter (anyOf 1)	number	Alternative	Minimum scheduling notice for events
allowBookingAfter (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
allowBookingAfterUnit	string	Optional	Unit for minimum scheduling notice Known values: hours, days, weeks, months, mins
allowBookingFor	JSON	Optional
allowBookingFor (anyOf 1)	number	Alternative	Minimum number of days/weeks/months for which to allow booking events
allowBookingFor (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
allowBookingForUnit	string	Optional	Unit for controlling the duration for which booking would be allowed for Known values: days, weeks, months
allowCancellation	boolean	Optional	Default: true
allowReschedule	boolean	Optional	Default: true
appoinmentPerDay	JSON	Optional
appoinmentPerDay (anyOf 1)	number	Alternative	Number of appointments that can be booked for a given day
appoinmentPerDay (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
appoinmentPerSlot	JSON	Optional
appoinmentPerSlot (anyOf 1)	number	Alternative	Maximum bookings per slot (per user). Maximum seats per slot in case of Class Booking Calendar. Default: 1
appoinmentPerSlot (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
autoConfirm	boolean	Optional	Default: true
availabilities	array	Optional	While we will support this property for backward compatibility, it is recommended to use 'Availability' APIs instead.
availabilities[]	Model	Each item	Expand Get Calendar — response body — calendar availabilities item
availabilityType	JSON	Optional
availabilityType (anyOf 1)	number	Alternative	While we will support this property for backward compatibility, it is not required anymore. Known values: 0, 1
availabilityType (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
calendarCoverImage	string	Optional
calendarType	string	Optional	Known values: round_robin, event, class_booking, collective, service_booking, personal
consentLabel	string	Optional
description	string	Optional
enableRecurring	boolean	Optional	Enable recurring appointments for the calendars. Please note that only one member should be added in the calendar to enable this Default: false
eventColor	string	Optional	Default: #039be5
eventTitle	string	Optional	Default: {{contact.name}}
eventType	string	Optional	Known values: RoundRobin_OptimizeForAvailability, RoundRobin_OptimizeForEqualDistribution Default: RoundRobin_OptimizeForAvailability
formId	string	Optional
formSubmitRedirectURL	string	Optional
formSubmitThanksMessage	string	Optional
formSubmitType	string	Optional	Known values: RedirectURL, ThankYouMessage Default: ThankYouMessage
googleInvitationEmails	boolean	Optional	Default: false
groupId	string	Optional	Group Id
guestType	string	Optional	Known values: count_only, collect_detail
id	string	Required within parent
isActive	boolean	Optional	Should the created calendar be active or draft Default: true
isLivePaymentMode	boolean	Optional
locationConfigurations	array	Optional	Meeting location configuration for event calendar
locationConfigurations[]	Model	Each item	Expand Get Calendar — response body — calendar location Configurations item
locationId	string	Required within parent
lookBusyConfig	JSON	Optional	Look Busy Configuration
lookBusyConfig (allOf 1)	Model	All variants apply	Expand Get Calendar — response body — calendar look Busy Config Look Busy Percentage, enabled
meetingLocation	string	Optional	🚨 Deprecated! Use `locationConfigurations.location` or `teamMembers[].locationConfigurations.location` instead. Read only: true
name	string	Required within parent
notes	string	Optional
notifications	array	Optional	🚨 Deprecated! Please use 'Calendar Notifications APIs' instead.
notifications[]	Model	Each item	Expand Get Calendar — response body — calendar notifications item
openHours	array	Optional	While we will support this property for backward compatibility, it is recommended to use 'Availability' APIs instead.
openHours[]	Model	Each item	Expand Get Calendar — response body — calendar open Hours item
pixelId	string	Optional
preBuffer	JSON	Optional
preBuffer (anyOf 1)	number	Alternative	Pre-Buffer is additional time that can be added before an appointment, allowing for extra time to get ready
preBuffer (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
preBufferUnit	string	Optional	Unit for pre-buffer. Known values: mins, hours
recurring	Model	Optional	Expand Get Calendar — response body — calendar recurring
shouldAssignContactToTeamMember	boolean	Optional
shouldSendAlertEmailsToAssignedMember	boolean	Optional
shouldSkipAssigningContactForExisting	boolean	Optional
slotBuffer	JSON	Optional
slotBuffer (anyOf 1)	number	Alternative	Slot-Buffer is additional time that can be added after an appointment, allowing for extra time to wrap up
slotBuffer (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
slotBufferUnit	string	Optional	Unit for slot buffer. Known values: mins, hours
slotDuration	JSON	Optional
slotDuration (anyOf 1)	number	Alternative	This controls the duration of the meeting Default: 30
slotDuration (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
slotDurationUnit	string	Optional	Unit for slot duration. Known values: mins, hours
slotInterval	JSON	Optional
slotInterval (anyOf 1)	number	Alternative	Slot interval reflects the amount of time the between booking slots that will be shown in the calendar. Default: 30
slotInterval (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
slotIntervalUnit	string	Optional	Unit for slot interval. Known values: mins, hours
slug	string	Optional
stickyContact	boolean	Optional
teamMembers	array	Optional	Team members are for calendars of type: Round Robin, Collective, Class, Service. Personal calendar must have exactly one team member.
teamMembers[]	Model	Each item	Expand Get Calendar — response body — calendar team Members item
widgetSlug	string	Optional
widgetType	string	Optional	Calendar widget type. Choose "default" for "neo" and "classic" for "classic" layout. Known values: default, classic Default: classic

Referenced models: Get Calendar — response body — calendar availabilities item, Get Calendar — response body — calendar notifications item, Get Calendar — response body — calendar location Configurations item, Get Calendar — response body — calendar look Busy Config Look Busy Percentage, enabled, Get Calendar — response body — calendar open Hours item, Get Calendar — response body — calendar recurring, Get Calendar — response body — calendar team Members item

Get Calendar — response body — calendar availabilities item

Field	Type	Presence	Description and constraints
$	object	Root
date	string	Required within parent	Formulate the date string in the format of `<YYYY-MM-DD in local timezone>T00:00:00.000Z`.
deleted	boolean	Optional	Default: false
hours	array	Required within parent
hours[]	Model	Each item	Expand Get Calendar — response body — calendar open Hours item hours item

Referenced models: Get Calendar — response body — calendar open Hours item hours item

Get Calendar — response body — calendar location Configurations item

Field	Type	Presence	Description and constraints
$	object	Root
kind	string	Required within parent	Type of meeting location. zoom_conference/google_conference/ms_teams_conference is not supported in event calendar type Known values: custom, zoom_conference, google_conference, inbound_call, outbound_call, physical, booker, ms_teams_conference
location	string	Optional	Address for meeting location. Not applicable on "zoom_conference", "google_conference" and "ms_teams_conference" kind
meetingId	string	Optional	Unique ID used to select a specific meeting location

Get Calendar — response body — calendar look Busy Config Look Busy Percentage, enabled

Field	Type	Presence	Description and constraints
$	object	Root
LookBusyPercentage	JSON	Required within parent
LookBusyPercentage (anyOf 1)	number	Alternative	Percentage of slots that will be hidden
LookBusyPercentage (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
enabled	boolean	Required within parent	Apply Look Busy Default: false

Get Calendar — response body — calendar notifications item

Field	Type	Presence	Description and constraints
$	object	Root
selectedUsers	string	Required within parent	Comma separated emails
shouldSendToContact	boolean	Required within parent
shouldSendToGuest	boolean	Required within parent
shouldSendToSelectedUsers	boolean	Required within parent
shouldSendToUser	boolean	Required within parent
type	string	Optional	Calendar Notification Known values: email Default: email

Get Calendar — response body — calendar open Hours item

Field	Type	Presence	Description and constraints
$	object	Root
daysOfTheWeek	array	Required within parent
daysOfTheWeek[]	JSON	Each item
daysOfTheWeek[] (anyOf 1)	number	Alternative	Maximum: 6 Minimum: 0
daysOfTheWeek[] (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hours	array	Required within parent
hours[]	Model	Each item	Expand Get Calendar — response body — calendar open Hours item hours item

Referenced models: Get Calendar — response body — calendar open Hours item hours item

Get Calendar — response body — calendar open Hours item hours item

Field	Type	Presence	Description and constraints
$	object	Root
closeHour	JSON	Required within parent
closeHour (anyOf 1)	number	Alternative	Maximum: 23 Minimum: 0
closeHour (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
closeMinute	JSON	Required within parent
closeMinute (anyOf 1)	number	Alternative	Maximum: 60 Minimum: 0
closeMinute (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
openHour	JSON	Required within parent
openHour (anyOf 1)	number	Alternative	Maximum: 23 Minimum: 0
openHour (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
openMinute	JSON	Required within parent
openMinute (anyOf 1)	number	Alternative	Maximum: 60 Minimum: 0
openMinute (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get Calendar — response body — calendar recurring

Field	Type	Presence	Description and constraints
$	object	Root
bookingOption	string	Optional	This setting contols what to do incase a recurring slot is unavailable Known values: skip, continue, book_next
bookingOverlapDefaultStatus	string	Optional	This setting contols what to do incase a recurring slot is unavailable Known values: confirmed, new
count	JSON	Optional
count (anyOf 1)	number	Alternative	Number of recurrences Maximum: 24
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
freq	string	Optional	Known values: DAILY, WEEKLY, MONTHLY

Get Calendar — response body — calendar team Members item

Field	Type	Presence	Description and constraints
$	object	Root
isPrimary	boolean	Optional	Marks a user as primary. This property is required in case of collective booking calendars. Only one user can be primary.
locationConfigurations	array	Optional	Meeting location configurations
locationConfigurations[]	Model	Each item	Expand Get Calendar — response body — calendar location Configurations item
meetingLocation	string	Optional	🚨 Deprecated! Use `locationConfigurations.location` instead. Read only: true
meetingLocationType	string	Optional	🚨 Deprecated! Use `locationConfigurations.kind` instead. Known values: custom, zoom, gmeet, phone, address, teams, booker Default: custom Read only: true
priority	JSON	Optional
priority (anyOf 1)	number	Alternative	Known values: 0, 0.5, 1 Default: 0.5
priority (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
userId	string	Required within parent

Referenced models: Get Calendar — response body — calendar location Configurations item

Get Calendars — response body

Field	Type	Presence	Description and constraints
$	object	Root
calendars	array	Optional
calendars[]	Model	Each item	Expand Get Calendar — response body — calendar

Referenced models: Get Calendar — response body — calendar

Get Free Slots — response body — value

Field	Type	Presence	Description and constraints
$	object	Root
slots	array	Required within parent
slots[]	string	Each item

Get Groups — response body

Field	Type	Presence	Description and constraints
$	object	Root
groups	array	Optional
groups[]	Model	Each item	Expand Update Group — response body — group

Referenced models: Update Group — response body — group

Get Notes — response body

Field	Type	Presence	Description and constraints
$	object	Root
hasMore	boolean	Optional
notes	array	Optional
notes[]	Model	Each item	Expand Create Note — calendars create Appointment Note — response body — note

Referenced models: Create Note — calendars create Appointment Note — response body — note

Get Service Booking by ID — response body

Field	Type	Presence	Description and constraints
$	object	Root
bookingId	string	Required within parent	Booking ID
contactId	string	Required within parent	Contact ID
createdBy	JSON	Required within parent	Booking booked by metadata
createdBy (allOf 1)	Model	All variants apply	Expand Create Service Booking — response body — created By source, user Id
dateAdded	string	Required within parent	Date Added
dateUpdated	string	Required within parent	Date Updated
deleted	boolean	Required within parent	Tells if the booking is deleted
endTime	string	Required within parent	End Time
locationId	string	Required within parent	Location ID
meetingLocation	string	Optional	Meeting Location (If service location is an ask the booker, then the meeting location is used for the booking)
serviceLocationId	string	Required within parent	Service Location ID
services	array	Required within parent	Services
services[]	Model	Each item	Expand Create Service Booking — response body — services item
startTime	string	Required within parent	Start Time
status	string	Required within parent	Status
timezone	string	Required within parent	Timezone
title	string	Required within parent	Service Booking Title

Referenced models: Create Service Booking — response body — created By source, user Id, Create Service Booking — response body — services item

Get Service Bookings — response body

Field	Type	Presence	Description and constraints
$	object	Root
bookings	array	Required within parent	Service Bookings
bookings[]	Model	Each item	Expand Get Service Booking by ID — response body

Referenced models: Get Service Booking by ID — response body

Get Service Locations — response body

Field	Type	Presence	Description and constraints
$	object	Root
serviceLocations	array	Required within parent	List of service locations
serviceLocations[]	Model	Each item	Expand Create Service Location — response body

Referenced models: Create Service Location — response body

Get Services — response body

Field	Type	Presence	Description and constraints
$	object	Root
services	array	Required within parent	List of services
services[]	Model	Each item	Expand Get Services — response body — services item

Referenced models: Get Services — response body — services item

Get Services — response body — services / item / payment / depositType: percentage, amount

Field	Type	Presence	Description and constraints
$	object	Root
amount	JSON	Optional
amount (anyOf 1)	number	Alternative	Service price
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
deposit	JSON	Optional
deposit (anyOf 1)	number	Alternative	Deposit amount or percentage value
deposit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
depositType	string	Optional	Deposit type Known values: percentage, amount

Get Services — response body — services item

Field	Type	Presence	Description and constraints
$	object	Root
coverImage	string	Optional	Service cover image URL
description	string	Optional	Service description
eventColor	string	Optional	Service event color (hex)
formId	string	Optional	Custom form ID (will be used to display the custom form on the booking page, if only one service is selected)
id	string	Required within parent	Service ID
isPrivate	boolean	Optional	Whether service is private (not shown publicly) Default: false
locationId	string	Required within parent	Location ID
name	string	Required within parent	Service name
payment	JSON	Optional	Payment details
payment (allOf 1)	Model	All variants apply	Expand Get Services — response body — services / item / payment / depositType: percentage, amount
postBuffer	JSON	Optional
postBuffer (anyOf 1)	number	Alternative	Post-buffer: Additional time that can be added after an appointment, allowing for extra time to wrap up
postBuffer (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
postBufferUnit	string	Optional	Post-buffer unit Known values: mins, hours
preBuffer	JSON	Optional
preBuffer (anyOf 1)	number	Alternative	Pre-Buffer is additional time that can be added before an appointment, allowing for extra time to get ready
preBuffer (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
preBufferUnit	string	Optional	Pre-buffer unit Known values: mins, hours
serviceCategoryId	string	Optional	Service category ID
serviceDuration	JSON	Optional
serviceDuration (anyOf 1)	number	Alternative	This controls the duration of the appointment
serviceDuration (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
serviceDurationUnit	string	Optional	Duration unit Known values: mins, hours
slug	string	Optional	Unique URL-friendly identifier
staff	array	Optional	Assigned staff members
staff[]	Model	Each item	Expand Create Service — request body — body staff item
variations	array	Optional	Service variations
variations[]	Model	Each item	Expand Get Services — response body — services item variations item

Referenced models: Get Services — response body — services / item / payment / depositType: percentage, amount, Get Services — response body — services item variations item, Create Service — request body — body staff item

Get Services — response body — services item variations item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	Variation ID
name	string	Required within parent	Variation name
payment	JSON	Optional	Payment details
payment (allOf 1)	Model	All variants apply	Expand Get Services — response body — services / item / payment / depositType: percentage, amount
postBuffer	JSON	Optional
postBuffer (anyOf 1)	number	Alternative	Post-buffer: Additional time that can be added after an appointment, allowing for extra time to wrap up
postBuffer (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
postBufferUnit	string	Optional	Post-buffer unit Known values: mins, hours
preBuffer	JSON	Optional
preBuffer (anyOf 1)	number	Alternative	Pre-Buffer is additional time that can be added before an appointment, allowing for extra time to get ready
preBuffer (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
preBufferUnit	string	Optional	Pre-buffer unit Known values: mins, hours
serviceDuration	JSON	Optional
serviceDuration (anyOf 1)	number	Alternative	This controls the duration of the appointment
serviceDuration (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
serviceDurationUnit	string	Optional	Duration unit Known values: mins, hours

Referenced models: Get Services — response body — services / item / payment / depositType: percentage, amount

Get event calendar availability schedule — response body

Field	Type	Presence	Description and constraints
$	object	Root
schedule	JSON	Required within parent	The event calendar schedule
schedule (allOf 1)	Model	All variants apply	Expand Get event calendar availability schedule — response body — schedule calendar Id, date Added, date Updated, rules, timezone

Referenced models: Get event calendar availability schedule — response body — schedule calendar Id, date Added, date Updated, rules, timezone

Get event calendar availability schedule — response body — schedule calendar Id, date Added, date Updated, rules, timezone

Field	Type	Presence	Description and constraints
$	object	Root
calendarId	string	Required within parent	Calendar ID associated with the schedule
dateAdded	string	Optional	Information about who created the schedule
dateUpdated	string	Optional	Information about who last updated the schedule
rules	array	Required within parent	Schedule rules defining when the schedule is active
rules[]	Model	Each item	Expand List user availability schedule — response body — schedules item rules item
timezone	string	Required within parent	Timezone for the schedule (IANA timezone identifier)

Referenced models: List user availability schedule — response body — schedules item rules item

Get notification — response body

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Optional	Notification ID
additionalEmailIds	array	Optional
additionalEmailIds[]	string	Each item
additionalPhoneNumbers	array	Optional
additionalPhoneNumbers[]	string	Each item
additionalWhatsappNumbers	array	Optional
additionalWhatsappNumbers[]	string	Each item
afterTime	array	Optional
afterTime[]	Model	Each item	Expand Get notification — response body — after Time item
beforeTime	array	Optional
beforeTime[]	Model	Each item	Expand Get notification — response body — after Time item
body	string	Optional
channel	string	Optional	Known values: email, inApp, sms, whatsapp
deleted	boolean	Optional
isActive	boolean	Optional
notificationType	string	Optional	Known values: booked, confirmation, cancellation, reminder, followup, reschedule
receiverType	string	Optional	Known values: contact, guest, assignedUser, emails, phoneNumbers, business
selectedUsers	array	Optional
selectedUsers[]	string	Each item
subject	string	Optional
templateId	string	Optional

Referenced models: Get notification — response body — after Time item

Get notification — response body — after Time item

Field	Type	Presence	Description and constraints
$	object	Root
timeOffset	JSON	Optional
timeOffset (anyOf 1)	number	Alternative
timeOffset (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
unit	string	Optional

Get user availability schedule — response body

Field	Type	Presence	Description and constraints
$	object	Root
schedule	JSON	Required within parent	Schedule
schedule (allOf 1)	Model	All variants apply	Expand List user availability schedule — response body — schedules item

Referenced models: List user availability schedule — response body — schedules item

List user availability schedule — response body

Field	Type	Presence	Description and constraints
$	object	Root
schedules	array	Required within parent	Array of schedules
schedules[]	Model	Each item	Expand List user availability schedule — response body — schedules item

Referenced models: List user availability schedule — response body — schedules item

List user availability schedule — response body — schedules item

Field	Type	Presence	Description and constraints
$	object	Root
calendarIds	array	Optional	Calendar IDs associated with the schedule
calendarIds[]	string	Each item
dateAdded	string	Required within parent	ISO date string when the schedule was created
dateUpdated	string	Required within parent	ISO date string when the schedule was last updated
deleted	boolean	Required within parent	Whether the schedule has been deleted
id	string	Required within parent	Unique identifier for the schedule
locationId	string	Required within parent	Location ID where this schedule applies
name	string	Required within parent	Human-readable name for the schedule
rules	array	Required within parent	Schedule rules defining when the schedule is active
rules[]	Model	Each item	Expand List user availability schedule — response body — schedules item rules item
timezone	string	Required within parent	Timezone for the schedule (IANA timezone identifier)
userId	string	Required within parent	User ID associated with the schedule

Referenced models: List user availability schedule — response body — schedules item rules item

List user availability schedule — response body — schedules item rules item

Field	Type	Presence	Description and constraints
$	object	Root
date	string	Optional	Specific date in YYYY-MM-DD format (only for date-type rules) Pattern: ^\d{4}-\d{2}-\d{2}$
day	string	Optional	Day of week (only for weekday-type rules) Known values: sunday, monday, tuesday, wednesday, thursday, friday, saturday
intervals	array	Required within parent	Time intervals for the rule (e.g., 9 AM to 5 PM)
intervals[]	Model	Each item	Expand Create user availability schedule — request body — body rules item intervals item
type	string	Required within parent	Type of schedule rule - weekday (recurring) or date (specific date) Known values: wday, date

Referenced models: Create user availability schedule — request body — body rules item intervals item

Update Appointment — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
address	string	Optional	Appointment Address
appointmentStatus	string	Optional	One of: new, confirmed, cancelled, showed, noshow, invalid, completed, active
assignedUserId	string	Optional	Assigned User Id
calendarId	string	Optional	Calendar Id
description	string	Optional	Appointment Description
endTime	string	Optional	End Time
ignoreDateRange	boolean	Optional	If set to true, the minimum scheduling notice and date range would be ignored
ignoreFreeSlotValidation	boolean	Optional	If true the time slot validation would be avoided for any appointment creation (even the ignoreDateRange)
meetingLocationId	string	Optional	The unique identifier for the meeting location. - This value can be found in `calendar.locationConfigurations`or `calendar.teamMembers[].locationConfigurations` Default: default
meetingLocationType	string	Optional	Meeting location type. - If `address` is provided in the request body, the `meetingLocationType` defaults to **custom**. One of: custom, zoom, gmeet, phone, address, ms_teams, google
overrideLocationConfig	boolean	Optional	Flag to override location config - **false** - If only `meetingLocationId` is provided - **true** - If only `meetingLocationType` is provided
rrule	string	Optional	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.
startTime	string	Optional	Start Time
title	string	Optional	Title
toNotify	boolean	Optional	If set to false, the automations will not run. Defaults to true Default: true

Update Calendar Resource — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
calendarIds	array	Optional	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	Optional	Capacity of the room.
description	string	Optional
isActive	boolean	Optional
locationId	string	Optional
name	string	Optional
outOfService	number	Optional	Quantity of the out of service equipment.
quantity	number	Optional	Quantity of the equipment.

Update Calendar Resource — response body

Field	Type	Presence	Description and constraints
$	object	Root
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

Update Calendar — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
alertEmail	string	Optional
allowBookingAfter	number	Optional	Minimum scheduling notice for events
allowBookingAfterUnit	string	Optional	Unit for minimum scheduling notice One of: hours, days, weeks, months, mins
allowBookingFor	number	Optional	Minimum number of days/weeks/months for which to allow booking events
allowBookingForUnit	string	Optional	Unit for controlling the duration for which booking would be allowed for One of: days, weeks, months
allowCancellation	boolean	Optional
allowReschedule	boolean	Optional
appoinmentPerDay	number	Optional	Number of appointments that can be booked for a given day
appoinmentPerSlot	number	Optional
autoConfirm	boolean	Optional
availabilities	array	Optional	While we will support this property for backward compatibility, it is recommended to use 'Availability' APIs instead.
availabilities[]	Model	Each item	Expand Update Calendar — request body — body availabilities item
availabilityType	number	Optional	While we will support this property for backward compatibility, it is not required anymore. One of: 0, 1
calendarCoverImage	string	Optional
consentLabel	string	Optional
description	string	Optional
enableRecurring	boolean	Optional	Enable recurring appointments for the calendars. Please note that only one member should be added in the calendar to enable this Default: false
eventColor	string	Optional	Default: #039be5
eventTitle	string	Optional
eventType	string	Optional	One of: RoundRobin_OptimizeForAvailability, RoundRobin_OptimizeForEqualDistribution
formId	string	Optional
formSubmitRedirectURL	string	Optional
formSubmitThanksMessage	string	Optional
formSubmitType	string	Optional	Default: ThankYouMessage One of: RedirectURL, ThankYouMessage
googleInvitationEmails	boolean	Optional
groupId	string	Optional	Group Id
guestType	string	Optional	One of: count_only, collect_detail
isActive	boolean	Optional
isLivePaymentMode	boolean	Optional
locationConfigurations	array	Optional	Meeting location configuration for event calendar
locationConfigurations[]	Model	Each item	Expand Create Calendar — request body — body location Configurations item
lookBusyConfig	JSON	Optional	Look Busy Configuration
lookBusyConfig (allOf 1)	Model	All variants apply	Expand Create Calendar — request body — body look Busy Config Look Busy Percentage, enabled
meetingLocation	string	Optional	🚨 Deprecated! Use `locationConfigurations.location` or `teamMembers[].locationConfigurations.location` instead. Read only: true
name	string	Optional
notes	string	Optional
notifications	array	Optional	🚨 Deprecated! Please use 'Calendar Notifications APIs' instead.
notifications[]	Model	Each item	Expand Create Calendar — request body — body notifications item
openHours	array	Optional	While we will support this property for backward compatibility, it is recommended to use 'Availability' APIs instead.
openHours[]	Model	Each item	Expand Create Calendar — request body — body open Hours item
pixelId	string	Optional
preBuffer	number	Optional	Pre-Buffer is additional time that can be added before an appointment, allowing for extra time to get ready
preBufferUnit	string	Optional	Unit for pre-buffer. One of: mins, hours
recurring	Model	Optional	Expand Create Calendar — request body — body recurring
shouldAssignContactToTeamMember	boolean	Optional
shouldSendAlertEmailsToAssignedMember	boolean	Optional
shouldSkipAssigningContactForExisting	boolean	Optional
slotBuffer	number	Optional	Slot-Buffer is additional time that can be added after an appointment, allowing for extra time to wrap up
slotDuration	number	Optional	This controls the duration of the meeting Default: 30
slotDurationUnit	string	Optional	Unit for slot duration. One of: mins, hours
slotInterval	number	Optional	Slot interval reflects the amount of time the between booking slots that will be shown in the calendar. Default: 30
slotIntervalUnit	string	Optional	Unit for slot interval. One of: mins, hours
slug	string	Optional
stickyContact	boolean	Optional
teamMembers	array	Optional	Team members are required for calendars of type: Round Robin, Collective, Class, Service. Personal calendar must have exactly one team member.
teamMembers[]	Model	Each item	Expand Create Calendar — request body — body team Members item
widgetSlug	string	Optional
widgetType	string	Optional	Calendar widget type. Choose "default" for "neo" and "classic" for "classic" layout. Default: classic One of: default, classic

Referenced models: Create Calendar — request body — body notifications item, Create Calendar — request body — body location Configurations item, Create Calendar — request body — body look Busy Config Look Busy Percentage, enabled, Create Calendar — request body — body open Hours item, Create Calendar — request body — body recurring, Create Calendar — request body — body team Members item, Update Calendar — request body — body availabilities item

Update Calendar — request body — body availabilities item

Field	Type	Presence	Description and constraints
$	object	Root
date	string	Required within parent	Formulate the date string in the format of `<YYYY-MM-DD in local timezone>T00:00:00.000Z`.
deleted	boolean	Optional	Default: false
hours	array	Required within parent
hours[]	Model	Each item	Expand Create Calendar — request body — body open Hours item hours item
id	string	Optional	The ID of the custom availability object. It is required while updating or deleting the existing custom date availability

Referenced models: Create Calendar — request body — body open Hours item hours item

Update Group — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
description	string	Required within parent
name	string	Required within parent
slug	string	Required within parent

Update Group — response body

Field	Type	Presence	Description and constraints
$	object	Root
group	Model	Optional	Expand Update Group — response body — group

Referenced models: Update Group — response body — group

Update Group — response body — group

Field	Type	Presence	Description and constraints
$	object	Root
description	string	Required within parent
id	string	Optional
isActive	boolean	Optional
locationId	string	Required within parent
name	string	Required within parent
slug	string	Required within parent

Update Service Booking — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
endTime	string	Optional	End Time
meetingLocation	string	Optional	Meeting Location (If service location is an ask the booker, then the meeting location is required)
serviceLocationId	string	Optional	Service Location ID
services	array	Optional	If provided, services sent in the request will replace the existing services in the booking.
services[]	Model	Each item	Expand Create Service Booking — request body — body services item
startTime	string	Optional	Start Time
status	string	Optional	Status One of: confirmed, cancelled, invalid, new, showed, no_show
timezone	string	Optional	Timezone
title	string	Optional	Title

Referenced models: Create Service Booking — request body — body services item

Update Service Location — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
address	string	Optional	Use a full street address when locationType is offline. Use a user-facing label when locationType is ask_booker.
coverImage	string	Optional	Updated URL of the cover image
locationType	string	Optional	Location type One of: offline, ask_booker
name	string	Optional	Location name
phone	string	Optional	Updated contact phone number
slug	string	Optional	Updated URL-friendly slug identifier

Update Service — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
coverImage	string	Optional	Service cover image URL
description	string	Optional	Service description
eventColor	string	Optional	Service event color (hex)
formId	string	Optional	Custom form ID (will be used to display the custom form on the booking page, if only one service is selected)
isPrivate	boolean	Optional	Whether service is private (not shown publicly)
name	string	Optional	Service name
payment	JSON	Optional	Payment details (currency configured in Service Global Settings is used.)
payment (allOf 1)	Model	All variants apply	Expand Create Service — request body — body / payment / depositType: percentage, amount
postBuffer	number	Optional	Post-buffer: Additional time that can be added after an appointment, allowing for extra time to wrap up
postBufferUnit	string	Optional	Post-buffer unit One of: mins, hours
preBuffer	number	Optional	Pre-Buffer is additional time that can be added before an appointment, allowing for extra time to get ready
preBufferUnit	string	Optional	Pre-buffer unit One of: mins, hours
serviceCategoryId	string	Optional	Service category ID
serviceDuration	number	Optional	This controls the duration of the appointment
serviceDurationUnit	string	Optional	Duration unit One of: mins, hours
slug	string	Optional	Unique URL-friendly identifier
staff	array	Optional	Assigned staff members
staff[]	Model	Each item	Expand Create Service — request body — body staff item
variations	array	Optional	Service variations (an empty array removes all variations). Include an id to update an existing variation; omit the id to create a new one.
variations[]	Model	Each item	Expand Update Service — request body — body variations item

Referenced models: Create Service — request body — body staff item, Create Service — request body — body / payment / depositType: percentage, amount, Update Service — request body — body variations item

Update Service — request body — body variations item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Optional	Variation ID
name	string	Optional	Variation name
payment	JSON	Optional	Payment details
payment (allOf 1)	Model	All variants apply	Expand Create Service — request body — body / payment / depositType: percentage, amount
postBuffer	number	Optional	Post-buffer: Additional time that can be added after an appointment, allowing for extra time to wrap up
postBufferUnit	string	Optional	Post-buffer unit One of: mins, hours
preBuffer	number	Optional	Pre-Buffer is additional time that can be added before an appointment, allowing for extra time to get ready
preBufferUnit	string	Optional	Pre-buffer unit One of: mins, hours
serviceDuration	number	Optional	This controls the duration of the appointment
serviceDurationUnit	string	Optional	Duration unit One of: mins, hours

Referenced models: Create Service — request body — body / payment / depositType: percentage, amount

Update event calendar availability schedule — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
rules	array	Optional	Updated schedule rules defining when the schedule is active
rules[]	Model	Each item	Expand Create user availability schedule — request body — body rules item
timezone	string	Optional	Updated timezone for the schedule (IANA timezone identifier) Pattern: ^[A-Za-z_]+/[A-Za-z_]+$

Referenced models: Create user availability schedule — request body — body rules item

Update notification — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
additionalEmailIds	array	Optional	Additional email addresses to receive notifications.
additionalEmailIds[]	string	Each item
additionalPhoneNumbers	array	Optional	Additional phone numbers to receive notifications.
additionalPhoneNumbers[]	string	Each item
afterTime	array	Optional	Specifies the time after which the follow-up notification should be sent. This is not required for other notification types.
afterTime[]	Model	Each item	Expand Update notification — request body — body after Time item
beforeTime	array	Optional	Specifies the time before which the reminder notification should be sent. This is not required for other notification types.
beforeTime[]	Model	Each item	Expand Update notification — request body — body after Time item
body	string	Optional	Body for email notification. Not necessary for in-App notification
channel	string	Optional	Notification channel One of: email, inApp, sms, whatsapp
deleted	boolean	Optional	Marks the notification as deleted (soft delete) Default: false
fromAddress	string	Optional	From address for email notification
fromName	string	Optional	From name for email/sms notification
fromNumber	string	Optional	from number for sms notification
isActive	boolean	Optional	Is the notification active Default: true
notificationType	string	Optional	Notification type One of: booked, confirmation, cancellation, reminder, followup, reschedule
receiverType	string	Optional	Notification recipient type One of: contact, guest, assignedUser, emails, phoneNumbers, business
selectedUsers	array	Optional	Selected users for in-App and business email notifications. Supports user IDs and special keyword "sub_account_admin"
selectedUsers[]	string	Each item
subject	string	Optional	Subject for email notification. Not necessary for in-App notification
templateId	string	Optional	Template ID for email notification

Referenced models: Update notification — request body — body after Time item

Update notification — request body — body after Time item

Field	Type	Presence	Description and constraints
$	object	Root
timeOffset	number	Optional
unit	string	Optional

Update user availability schedule — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
name	string	Optional	Human-readable name for the schedule
rules	array	Optional	Updated schedule rules defining when the schedule is active
rules[]	Model	Each item	Expand Create user availability schedule — request body — body rules item
timezone	string	Optional	Updated timezone for the schedule (IANA timezone identifier) Pattern: ^[A-Za-z_]+/[A-Za-z_]+$

Referenced models: Create user availability schedule — request body — body rules item

Validate group slug — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
locationId	string	Required within parent	Location Id
slug	string	Required within parent	Slug

Validate group slug — response body

Field	Type	Presence	Description and constraints
$	object	Root
available	boolean	Required within parent