These docs are for v1.0. Click to read the latest docs for v3-prod.

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

appointment id to book

Body Params
string | null
string | null
string | null
string | null
string | null
string | null
string | null
int32 | null
customFields
object
appointmentBookingFields
array of objects | null
appointmentBookingFields
customerBookingFields
array of objects | null
customerBookingFields
Headers
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Response

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json