<- Bookings API

Bookings API

Cancel booking

POST

 /v2/bookings/{booking_id}/cancel

Cancels an existing booking.

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

Path parameters

Example code

Link to section

booking_id

string

Required

The ID of the Booking object representing the to-be-cancelled booking.

Link to section

Request body

Link to section

idempotency_key

string

A unique key to make this request an idempotent operation.

Max Length
255
Link to section

booking_version

integer(32-bit)

The revision number for the booking used for optimistic concurrency.

Link to section

Response fields

Link to section

booking

The booking that was cancelled.

Link to section

errors

Errors that occurred during the request.