Cancel a booking
Header Parameters
Api-Keystring
Path Parameters
external_idstring Required
Booking identifier in the external service (as sent to POST /reserves).
Max length
64
Pattern
^[A-Za-z0-9_-]+$
Body Parameters
refundboolean
Only for external payments: record the refund of the paid amount.
Default value
true
reasonstring
Free-text reason, stored for information.
Response
200
Object
Cancelled booking (crud envelope) or a reserves error.
Response Attributes
oneOfoneof
Choose one of the following oneOf options
Show child attributes
successboolean
errorstring
error_codenumber | string
totalnumber
summaryobject
Show child attributes
dataarray
Show child attributes
401
Object
Session not established / invalid key.
Response Attributes
successboolean
dataarray
errorstring
session_expiredboolean
totalinteger
Was this section helpful?
Response
Was this section helpful?