Reserve an appointment slot (no auto-expiry)

post

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

Reserve a time slot with status RS (Reserved). Unlike /hold, there is no expiration
based on location.expirationDelay. No notifications or external calendar events until the
slot is finalized with PUT /v3/appointment/{id}/book.

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 reservation.

ServiceId

uuid

required

The service for the reservation.

allowPaddingOverflow

boolean

Defaults to false

When true, allows the padding to overflow the end of the slot.

Body Params

Same shape as a hold: Unavailability times required; Customer optional.
Status is set to RS and is not accepted in the body.

Payload used to reserve a slot without a hold expiration. Same fields as a hold (start/end times inside Unavailability, optional customer details, notes, etc.). Status is set to RS 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).

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

200Appointment reserved successfully.