latestSwagger 2.02026-08-10143234301.7 KB

dc2736850e42

Rest

Books single or multiple appointments and sends booking confirmation email. Makes single or multiple appointment requests and sends appointment requested email if booking option is turned off. Books and applies payment for single appointment if payment is required and sends booking confirmation email. Location Id,StaffReference, AppointmentTypeReference, Range is required. checkVerified is a boolean used for Connect on versions above 2.0.4. Returns booked appointment details

post/Consumer/Schedules/Location/{locationId}/Appointments

Path parameters

locationIdinteger required

Location Id is required.

Query parameters

checkVerifiedboolean

Boolean used for Connect on versions above 2.0.4

searchIdinteger
userIdstring
creditCardTokenIdstring

Headers

Authorizationstring required

Bearer {user_token}

SiteIdinteger required

Site ID

Request body

AppointmentTypeReferenceinteger
StaffReferenceinteger
AvailabilityReferenceinteger
LocationReferenceinteger
ConsumerReferenceinteger
Notesstring
ReservedByConsumerReferenceinteger
ReservedForstring
ResourceReferencesinteger[]
GenderPreference'Male' | 'Female' | 'None'
PrepTimeinteger
FinishTimeinteger
WrapupTimeinteger
TrainerRequestedboolean
RestSourcestring
Recurringboolean
RecurringAppointmentGroupIdinteger

Response

Returns a ConsumerBookAppointmentManagerResponse if the option to allow clients to book online is turned on; or a ConsumerRequestAppointmentManagerResponse otherwise.

object required