Platform: cancel a booking on the business's behalf

post/api/v1/platform/businesses/{id}/bookings/{reference}/cancel

Request

  • Base URL: http://127.0.0.1:4310
  • URL: http://127.0.0.1:4310/api/v1/platform/businesses/{id}/bookings/{reference}/cancel
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sfb_session

Path parameters

idstring required
referencestring required

Request body

reasonstring required
if_versioninteger required
idempotency_keystring required
notify_clientboolean

false cancels without emailing or texting the client

cancel_reasonstring

Kept on the booking; the reason field is the support justification

Response

OK

object required

Changes

No recorded changes to this operation across all 4 revisions of this API.