Off Hours
Use Off Hours to request an appointment outside the displayed availability.
The popup displays the off-hours fee and lets the user enter a preferred appointment time.
This screen includes:
| # | Element | Description |
|---|---|---|
| 1 | Modal header | Displays the off-hours time selection title |
| 2 | Close action | Dismisses the off-hours popup |
| 3 | Off-hours fee | Displays the additional fee for the selected appointment option |
| 4 | Instruction text | Requests a preferred off-hours appointment time |
| 5 | Time input field | Allows entry of a preferred appointment time |
| 6 | Time picker action | Opens the time selection control |
| 7 | Cancel action | Closes the popup without changes |
| 8 | Continue action | Submits the selected off-hours appointment time |
| 9 | Background scheduling screen | Displays the selected date and available appointment times |
Workflow
- Open time and location selection.
- Select an appointment option that supports off-hours requests.
- Open the off-hours time selection popup.
- Review the off-hours fee.
- Enter a preferred appointment time.
- Select Continue.
- Submit the off-hours request.
- Continue the booking flow.
Validations
| Scenario | App Behavior | SDK Output |
|---|---|---|
| Off-hours supported | Display off-hours popup | offHours = available |
| Time not entered | Block submission | validation = required |
| Time entered | Enable submission | validation = valid |
| Request accepted | Continue booking flow | status = success |
| Request rejected | Display error state | status = 405 |
Actions
| Scenario | App Behavior | SDK Output |
|---|---|---|
| Off-hours popup opened | Load off-hours request popup | PUT /api/v3/wizard/time-location-selection/off-hours |
| Time selected | Update preferred appointment time | time = updated |
| Continue selected | Submit off-hours request | POST /api/v3/wizard/time-location-selection/off-hours/submit |
| Cancel selected | Close popup | state = cancelled |
| Close selected | Dismiss popup | state = dismissed |
Endpoint Resources
Off Hours for Edit
PUT
v3/wizard/time-location-selection/{appointment-id}/off-hours
Returns the off-hours time selection popup.
Submit Off Hours
POST
v3/wizard/time-location-selection/off-hours/submit
Submits the selected off-hours time.