Appointments

Book Appointment

Use this endpoint to Book an appointment. Only appointments with an "IN" status, Initial, can be booked. A valid appointment id is required. Use the appointment id returned from the initial POST /consumer/v1/appointments endpoint. Other pertinent fields can also be updated at the time of booking by including them in the post body. Note: If no name or email address was provided in the initial Post Appointment, it will be required in the post body.

For more information: Appointments Overview

put/consumer/v1/appointments/{id}/book

Request

Base URL
https://sandbox-api.onsched.com
Auth
OAuth 2
Client credentials
Token URLhttps://sandbox-identity.onsched.com/connect/token
ScopesOnSchedApi
TypeScript
https://skmtc.dev/onsched/apis/onsched-consumer-api/docs/consumer/v1/appointments/:id/book/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

appointment id to book

Request body

emailstring nullable

namestring nullable

phonestring nullable

phoneTypestring nullable

phoneExtstring nullable

customerMessagestring nullable

notesstring nullable

groupSizeinteger nullable

Response

Success

objectstring nullable

idstring nullable

locationIdstring nullable

businessNamestring nullable

calendarIdstring nullable

serviceIdstring nullable

serviceNamestring nullable

serviceImageUrlstring nullable

resourceIdstring nullable

resourceNamestring nullable

resourceGroupIdstring nullable

resourceGroupNamestring nullable

resourceImageUrlstring nullable

resourceEmailstring nullable

customerIdstring nullable

serviceAllocationIdstring nullable

rescheduledIdstring nullable

createDatestring nullable

startDateTimestring nullable

endDateTimestring nullable

dateInternationalstring nullable

datestring nullable

timeinteger

durationinteger

timezoneinteger nullable

timezoneIdstring nullable

timezoneIanastring nullable

ipAddressstring nullable

statusstring nullable

confirmationNumberstring nullable

downloadIcsUrlstring nullable

bookedBystring nullable

onlineBookingboolean nullable

confirmedboolean

emailstring nullable

namestring nullable

lastnamestring nullable

firstnamestring nullable

phonestring nullable

phoneTypestring nullable

phoneExtstring nullable

customerMessagestring nullable

notesstring nullable

groupSizeinteger nullable

lastModifiedOnstring nullable

lastModifiedBystring nullable

emailConfirmationSentstring nullable

emailReminderSentstring nullable

smsConfirmationSentstring nullable

smsReminderSentstring nullable

locationstring nullable

latitudestring nullable

longitudestring nullable

stripeChargeIdstring nullable

stripeRefundIdstring nullable

paymentStatusinteger

customFieldsobject nullable

Changes

No recorded changes to this operation across all 1 revision of this API.