Edit an Appointment reservation

Request

Updates an unconfirmed reservation in place - slot, practitioner, reason, patient proxy - and re-stamps the reservation hold, returning the fresh reserved_until. Only appointments in the reserved state can be edited; use Reschedule for confirmed appointments. Works for both booking mechanisms - a reservation has not touched the EHR yet. The location and appointment type cannot change - release the reservation and re-reserve to move site or change type.

Security

apiKeyAuth and practiceGroupId

Path

idstringrequired

Bodyapplication/jsonrequired

start_timestring or null, (date-time)required

ISO 8601 date format

Example:"1989-04-11"

practitioner_idstring^\d+$required

durationnumber, >= 1

reasonstring

patient_proxy_idstring or null^\d+$

curl -i -X PUT \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v2/appointments/{id}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "start_time": "1989-04-11",
    "practitioner_id": "string",
    "duration": 1,
    "reason": "string",
    "patient_proxy_id": "string"
  }'

Responses

Ok

Bodyapplication/json

idstring^\d+$required

reserved_untilstring or null, (date-time)required

Response

{
  "id": "string",
  "reserved_until": "2019-08-24T14:15:22Z"
}