Book a held appointment

put

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

Book a held appointment (status IN or HD) by providing complete customer information. Updates status to BK (Booked) and triggers notifications, webhooks, and calendar syncs. Ensure the appointment is still available; conflicts will return 409.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

required

The unique ID of the held appointment to book.

Query Params

includePaddingEvent

boolean

Defaults to false

When true, creates a separate padding event in external calendars (Google Calendar, Outlook)

includeCustomerAttendee

boolean

Defaults to true

When false, the customer is not added as an attendee on the external calendar event.

Body Params

Provide full customer details to confirm the booking. Includes name, email, phone, and optional notes or custom fields. Use this after holding a slot to complete the reservation. Status is automatically set to BK; omitting the status field is required. Unavailability is ignored on this route—use PUT /v3/appointment/{id} to reschedule.

bookedBy

string

notes

string

location

string

Customer

object

CustomFields

object

Optional key/value metadata captured during booking.

Responses

400

Bad request - invalid customer data or missing fields.

401

Unauthorized.

403

Forbidden.

404

Appointment not found or not in held status.

409

Conflict - time slot no longer available.

Language

Credentials

Loading…

Response

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

application/json

200Successfully booked the appointment.