Validate appointment resource changes

post

https://api-stage.onsched.com/v3/appointment/{id}/validateResources

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

required

Query Params

availabilityMode

string

enum

Match reschedule validation by bypassing operating hours, allocation windows, clinic/resource schedule blocks, and existing appointment padding overlaps, while retaining appointment occupancy, configured capacity, quotas, customer limits, and external-calendar rules. Mutually exclusive with ignoreAvailability=true.

Allowed:

Body Params

Preflight a resource assignment before saving a reschedule. This endpoint does not mutate the appointment,
create calendar events, or send notifications. Call PUT /v3/appointment/{id}/reschedule to persist the change.

ResourceIds

array of uuids

required

length ≥ 1

Proposed resource assignment for the appointment.

ResourceIds*

Unavailability

object

Optional time window to validate. When omitted, the appointment's current start and end time are used.

Responses

400

Invalid resource list — a ResourceIds entry is not a resource of this company or is not linked to the appointment's location and service — or the slot is unavailable.

401

Unauthorized.

403

Forbidden.

404

Appointment not found.

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Proposed resource assignment is valid for the appointment time.