Book an Appointment

Request

Submits a previously reserved appointment for booking. Returns immediately with status "pending"; the booking is confirmed asynchronously. Poll Get Appointment Status for the outcome.

Only appointments reserved with booking_mechanism: ehr_confirmed can be booked here; hero_confirmed appointments must be booked via the v1 endpoint.

Security

apiKeyAuth and practiceGroupId

Path

idstringrequired

Bodyapplication/jsonrequired

reasonstring

patient_idstring^\d+$required

billpayer_idstring^\d+$

suppress_invoiceboolean

suppress_availability_checkboolean

externally_paidboolean

episode_idstring^\d+$

curl -i -X PATCH \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v2/appointments/{id}/book' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "reason": "string",
    "patient_id": "string",
    "billpayer_id": "string",
    "suppress_invoice": true,
    "suppress_availability_check": true,
    "externally_paid": true,
    "episode_id": "string"
  }'

Responses

Ok

Bodyapplication/json

idstring^\d+$required

statusstringrequired

Enum:"reserved""pending""confirmed""cancelling""rescheduling""abandoned""cancelled""failed""unknown"

Response

{
  "id": "string",
  "status": "reserved"
}