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:
| # | Element | Description |
|---|---|---|
| 1 | Header | Displays screen title and back navigation |
| 2 | Appointment summary | Displays doctor, appointment date, price, and visit type |
| 3 | Coverage section | Displays payment responsibility |
| 4 | Patient details section | Displays patient information |
| 5 | Contact information section | Updates email and phone number |
| 6 | Notification preferences | Selects appointment update channels |
| 7 | Medications section | Updates medication usage information |
| 8 | Medical issue section | Updates symptoms and medical details |
| 9 | Upload documents action | Uploads medical attachments |
| 10 | Continue action | Continues to the next wizard step |
Workflow
- Open Appointment Details.
- Select Edit appointment.
- Render editable sections from the wizard response.
- Update supported fields.
- Recalculate charges when pricing changes.
- Apply a promo code when supported.
- Continue to payment when required.
- Submit appointment changes.
- Refresh appointment details.
Validations
| Scenario | App Behavior | SDK Output |
|---|---|---|
Appointment state = Requested | Enable scheduling fields | state = editable |
Appointment state = Scheduled | Lock scheduling fields | state = read_only |
| Editable flag = false | Lock field | field = locked |
| Payment required | Render payment section | payment = required |
| Promo code unsupported | Hide promo code field | promoCode = unavailable |
| Promo code invalid | Display validation error | error = invalid_promo_code |
| Promo code applied | Recalculate charges | discount = applied |
| Email format invalid | Block submission | error = invalid_email |
| Phone format invalid | Block submission | error = invalid_phone |
| Medical issue exceeds limit | Block submission | error = invalid_medical_issue |
| Address lookup fails | Display address error | error = address_search_failed |
| Medication update fails | Display medication error | error = medication_update_failed |
| No editable values changed | Skip submission | state = unchanged |
| Update succeeds | Refresh appointment | status = 204 |
| Update rejected | Display error state | state = error |
Actions
| Scenario | App Behavior | SDK Output |
|---|---|---|
| Edit appointment selected | Load wizard | PUT /api/v3/wizard/edit |
| Contact information modified | Update wizard state | contact = updated |
| Medical issue modified | Update wizard state | medicalIssue = updated |
| Attachment uploaded | Update attachments | attachments = updated |
| Address search requested | Load address suggestions | PATCH /api/v3/wizard/addresses/search |
| Address selected | Populate address fields | PATCH /api/v3/wizard/addresses/select |
| Medication modified | Update medications | PATCH /api/v3/wizard/update/medications |
| Promo code submitted | Recalculate pricing | pricing = recalculated |
| Continue to payment selected | Open payment flow | navigation = payment |
| Payment modified | Update checkout state | PATCH /api/v3/wizard/appointments/checkout |
| Update selected | Submit appointment changes | POST /api/v3/wizard/appointments/update |
| Update succeeds | Display confirmation state | state = updated |
| Update rejected | Preserve current appointment state | state = 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.
