HomeBook an Intro CallStartup Program
API Endpoints

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
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
ResourceIds
array of uuids
required

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

ResourceIds*
uuid
required

The location for the hold.

uuid
required

The service for the hold.

boolean
Defaults to false

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

Body Params

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

string
boolean
string
string
number
number
boolean
Defaults to false
integer
required
≥ 1

Duration of the appointment in minutes

string
CustomFields
object
Customer
object
Unavailability
object
required
Responses

400

Validation error (missing times, invalid UUIDs).

409

Slot unavailable (overlap).

Updated 5 months ago

Language
Credentials
Required Scopes
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago