Skip to main content

Edit 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
Appointment state = RequestedEnable scheduling fieldsstate = editable
Appointment state = ScheduledLock scheduling fieldsstate = read_only
Editable flag = falseLock fieldfield = locked
Payment requiredRender payment sectionpayment = required
Promo code unsupportedHide promo code fieldpromoCode = unavailable
Promo code invalidDisplay validation errorerror = invalid_promo_code
Promo code appliedRecalculate chargesdiscount = applied
Email format invalidBlock submissionerror = invalid_email
Phone format invalidBlock submissionerror = invalid_phone
Medical issue exceeds limitBlock submissionerror = invalid_medical_issue
Address lookup failsDisplay address errorerror = address_search_failed
Medication update failsDisplay medication errorerror = medication_update_failed
No editable values changedSkip submissionstate = unchanged
Update succeedsRefresh appointmentstatus = 204
Update rejectedDisplay error statestate = error

Actions

ScenarioApp BehaviorSDK Output
Edit appointment selectedLoad wizardPUT /api/v3/wizard/edit
Contact information modifiedUpdate wizard statecontact = updated
Medical issue modifiedUpdate wizard statemedicalIssue = updated
Attachment uploadedUpdate attachmentsattachments = updated
Address search requestedLoad address suggestionsPATCH /api/v3/wizard/addresses/search
Address selectedPopulate address fieldsPATCH /api/v3/wizard/addresses/select
Medication modifiedUpdate medicationsPATCH /api/v3/wizard/update/medications
Promo code submittedRecalculate pricingpricing = recalculated
Continue to payment selectedOpen payment flownavigation = payment
Payment modifiedUpdate checkout statePATCH /api/v3/wizard/appointments/checkout
Update selectedSubmit appointment changesPOST /api/v3/wizard/appointments/update
Update succeedsDisplay confirmation statestate = updated
Update rejectedPreserve current appointment statestate = unchanged

Endpoint Resources

Wizard for Edit

PUT 

v3/wizard/edit

Return wizard screen for editing or rescheduling an existing appointment.

Patch Search Address

PATCH 

v3/wizard/addresses/search

Search address suggestions for home visit using autocomplete.

Patch Fill Address

PATCH 

v3/wizard/addresses/select

Select a suggested address by maps location ID and fill wizard address fields.

Stripe Patch Proxy

PATCH 

v3/wizard/appointments/checkout

Perform minimal booking or checkout action payload for Stripe proxy flow.

Patch Medications

PATCH 

v3/wizard/update/medications

Update the medications section of the wizard.

Update Appointment

POST 

v3/wizard/appointments/update

Update an existing appointment using wizard data; expect a 204 response with no response body.