Hold an appointment slot

post

https://api-stage.onsched.com/v3/appointment/hold

Hold a time slot, creating an appointment with initial status IN (Inquiry/Hold).
No immediate notifications; complete booking later via the /book endpoint.
Use for cart-like flows; holds may expire if not booked in time.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

ResourceIds

array of uuids

required

Create query param per resource, e.g., ResourceIds=uuid1&ResourceIds=uuid2

ResourceIds*

LocationId

uuid

required

The location for the hold.

ServiceId

uuid

required

The service for the hold.

allowPaddingOverflow

boolean

Defaults to false

When true, allows padding past operating-hours close only on the last availability block of the local day. Mid-day slots still enforce full padding.

Body Params

Minimal data required: startTime, endTime. Customer is optional (email recommended).
Use this to reserve a slot for later booking.

Payload used to place an appointment on hold. Provide the same fields as when creating an appointment (start/end times inside Unavailability, optional customer details, notes, etc.). Status is managed internally and must not be supplied.

bookedBy

string

confirmed

boolean

notes

string

location

string

latitude

number

longitude

number

repeated

boolean

Defaults to false

duration

integer

required

≥ 1

Duration of the appointment in minutes

ipAddress

string

CustomFields

object

Customer

object

Unavailability

object

required

Responses

400

Validation error (missing times, invalid UUIDs), unknown LocationId/ServiceId, a ResourceIds entry that is not a resource of this company or is not linked to the requested location and service, or the slot is unavailable.

409

Slot unavailable (overlap).

Language

Credentials

Loading…

Response

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

application/json

201Appointment held successfully.