v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB

Bookings

CancelBooking

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.

post/v2/bookings/{booking_id}/cancel

Path parameters

booking_idstring required

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

Request body

idempotency_keystring nullable

A unique key to make this request an idempotent operation.

booking_versioninteger nullable

The revision number for the booking used for optimistic concurrency.

Response

Success

Example response

{
  "booking": {
    "appointment_segments": [
      {
        "duration_minutes": 60,
        "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC",
        "service_variation_version": 1599775456731,
        "team_member_id": "TMXUrsBWWcHTt79t"
      }
    ],
    "created_at": "2020-10-28T15:47:41Z",
    "customer_id": "EX2QSVGTZN4K1E5QE1CBFNVQ8M",
    "customer_note": "",
    "id": "zkras0xv0xwswx",
    "location_id": "LEQHH0YY8B42M",
    "seller_note": "",
    "start_at": "2020-11-26T13:00:00Z",
    "status": "CANCELLED_BY_CUSTOMER",
    "updated_at": "2020-10-28T15:49:25Z",
    "version": 1
  },
  "errors": []
}