Cancel a booking
POST/v1/bookings/:id/cancel
Cancels a pending or confirmed appointment, frees the time and emails the customer. With refund: true, a payment made through Stripe goes back to the customer. Requires the write:bookings scope.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 409
- 502
The booking, now cancelled.
validation_error: the body, a path or a query parameter is not valid. message names each problem, e.g. firstName: Required.
missing_api_key or invalid_api_key: no API key was sent, or it is wrong, expired or revoked.
insufficient_scope: the API key does not have the scope this endpoint needs. required names it.
not_found: there is no such record in your company.
not_cancellable: only a pending or confirmed booking can be cancelled.
booking_failed: the booking service could not do it; message has the details.