bookings

Cancel a booking (only when supported)

Requires a mandate with action cancel_booking. Only available when the business capabilities.cancellation is true — otherwise you get CANCELLATION_NOT_ALLOWED. Do not offer cancellation to users for businesses where it is unsupported.

post/bookings/{bookingId}/cancel

Request

  • Base URL: https://agentbookable.com
  • URL: https://agentbookable.com/bookings/{bookingId}/cancel
  • Auth: none declared

Path parameters

bookingIdstring required

Request body

businessIdstring required
mandateRefstring required
reasonstring
idempotencyKeystring

Response

Cancelled booking

idstring
businessIdstring
serviceIdstring
staffIdstring nullable
startstring
endstring
status'confirmed' | 'pending' | 'cancelled' | 'completed'
createdVia'agent'
mandateRefstring
createdAtstring
updatedAtstring

Example response

{
  "id": "bb_bkg_3e74e9ebd024c32b"
}

Changes

No recorded changes to this operation across all 1 revision of this API.