Sign in

v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Bookings

CancelBooking

Allows a property to cancel a booking on your OTA from the Cloudbeds side.

IMPORTANT: Please contact us to enable this capability for your channel. It is NOT enabled by default.

The reason why the booking is to be canceled is given in the reason field. If the booking cannot be canceled the error code should be provided. Here are possible error codes:

  • 4001 - booking has already departed
  • 4002 - booking is already canceled
  • 4003 - booking cannot be canceled. The reason is provided in the msg field.
post/CancelBooking

Request body

mya_property_idinteger required

Property ID on the Cloudbeds channel manager

ota_property_idstring required

Username, login or property ID on the OTA

ota_property_passwordstring required

Password for property on your OTA. In case the OTA does not use passwords this will be an empty string.

ota_property_sub_idstring required

Property ID on the OTA, if OTA supports multiple properties under one ota_property_id/ota_property_password combination. See GetSubProperties for more details.

guidstring required

Request reference ID, used for debugging and support requests.

shared_secretstring required

Authentication between the OTA and the channel. Identical for all requests. Not to be shared with customers.

ota_cidstring required

OTA ID as given by Cloudbeds

verb'CancelBooking' required
booking_idstring required

OTA booking ID of the booking to be cancelled.

reasonstring

Free text reason given by property as to why the booking was cancelled.

Response

CancelBooking

successtrue | false required