Reschedule Appointment

Request

Asynchronously reschedules an EHR-confirmed appointment to a new slot (book-new then cancel-old). Returns immediately with a rescheduling status; poll the status endpoint for the outcome.

Security

apiKeyAuth and practiceGroupId

Path

idstringrequired

Bodyapplication/jsonrequired

start_timestring or null, (date-time)required

ISO 8601 date format

Example:"1989-04-11"

durationnumber, >= 1required

practitioner_idstring^\d+$required

suppress_availability_checkboolean

suppress_mailboolean

episode_idstring^\d+$

curl -i -X PATCH \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v2/appointments/{id}/reschedule' \
  -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",
    "duration": 1,
    "practitioner_id": "string",
    "suppress_availability_check": true,
    "suppress_mail": 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"
}