<- Bookings API

Bookings API

Create booking

POST

 /v2/bookings

Creates a booking.

The required input must include the following:

  • Booking.location_id
  • Booking.start_at
  • Booking.team_member_id
  • Booking.AppointmentSegment.service_variation_id
  • Booking.AppointmentSegment.service_variation_version

To call this endpoint with buyer-level permissions, set APPOINTMENTS_WRITE for the OAuth scope. To call this endpoint with seller-level permissions, set APPOINTMENTS_ALL_WRITE and APPOINTMENTS_WRITE for the OAuth scope.

For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to Appointments Plus or Appointments Premium.

Permissions:APPOINTMENTS_WRITE
Try in API Explorer
Link to section

Request body

Example code

Link to section

idempotency_key

string

A unique key to make this request an idempotent operation.

Link to section

booking

Required

The details of the booking to be created.

Link to section

Response fields

Link to section

booking

The booking that was created.

Link to section

errors

Errors that occurred during the request.