Skip to content
API Docs/
API Reference
/
/
Book an Appointment

Book an Appointment
deprecated

Request

Deprecated: new integrations should use PATCH /v2/appointments/{id}/book (bookAppointmentV2) instead. This endpoint remains available for existing hero_confirmed integrations.

Confirm a previously reserved appointment. This transitions the appointment from reserved to booked status and triggers any configured notifications (e.g. patient confirmation SMS).

The appointment must have been created via the Create Appointment endpoint first. Appointments reserved with booking_mechanism: ehr_confirmed must be booked via the v2 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/v1/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 '{
    "patient_id": "1234",
    "billpayer_id": "5678",
    "reason": "Annual health check",
    "suppress_availability_check": false,
    "externally_paid": false
  }'

Responses

Ok

Response
No content