Skip to main content

Edit Scheduled Appointment


Use the Edit Appointment wizard to modify an existing appointment.

Editable sections, pricing, promo code support, payment requirements, and available actions derive from the wizard response.

This screen includes:

#ElementDescription
1HeaderDisplays screen title and back navigation
2Appointment summaryDisplays doctor, appointment date, price, and visit type
3Coverage sectionDisplays payment responsibility
4Patient details sectionDisplays patient information
5Contact information sectionUpdates email and phone number
6Notification preferencesSelects appointment update channels
7Medications sectionUpdates medication usage information
8Medical issue sectionUpdates symptoms and medical details
9Upload documents actionUploads medical attachments
10Continue actionContinues to the next wizard step

Workflow

  1. Open Appointment Details.
  2. Select Edit appointment.
  3. Render editable sections from the wizard response.
  4. Update supported fields.
  5. Recalculate charges when pricing changes.
  6. Apply a promo code when supported.
  7. Continue to payment when required.
  8. Submit appointment changes.
  9. Refresh appointment details.

Validations

ScenarioApp behaviorSDK output
Authentication is invalidBlock access to the edit screenstate = unauthenticated
Appointment ID is missingDo not submit the requesterror = missing_appointment_id
Appointment ID is invalidDisplay an appointment errorerror = invalid_appointment_id
Appointment cannot be editedDisplay the returned unavailable statestate = unavailable
Appointment can be editedDisplay the edit screenstate = editable
Required response data is missingDisplay an error stateerror = invalid_response
Request is in progressDisplay a loading statestate = loading
Request succeedsRender the returned pagestatus = 200
Request failsDisplay the returned errorstatus = 405

Actions

ScenarioApp behaviorSDK output
Edit appointment selectedRequest the edit screenPUT /api/v3/appointments/{appointment-id}/edit
Appointment ID submittedAdd the appointment ID to the request pathappointmentId = submitted
Location selectedAdd the location ID to the requestlocationId = selected
Preferred date and time selectedAdd the date and time to the requestdateTime = selected
Request submittedDisplay a loading statestate = loading
Request succeedsRender the returned pagestatus = 200
Request failsDisplay the returned error statestatus = 405
Back selectedReturn to appointment detailsnavigation = appointment_details
Continue selectedProcess the action defined by the returned pageaction = continue

Endpoint Resources

Wizard for Edit

PUT 

v3/appointments/{appointment-id}/edit

Returns the screen to edit or reschedule an existing appointment.