AckBooking

Allows Cloudbeds to acknowledge 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.

One AckBooking is sent per booking, after the booking has been imported and
handed to the property's PMS. Bookings are not acknowledged in the order they
were delivered — cancellations are processed ahead of new and modified
bookings — so do not infer any ordering from the sequence of calls. Use
acknowledgement_id or version to identify which delivery is being
acknowledged:

  • For bookings you pushed to us with the BookingCreate callback, we return
    acknowledgement_id, one of the acknowledgement_ids we returned in that
    callback's response.
  • For bookings we pulled with GetBookingList, we return version, the value
    you supplied for that booking in the GetBookingList response.

A booking that is delivered again — a modification, or a redelivery after a
failed import — is acknowledged again, with the identifier belonging to that
delivery.

If the booking cannot be acknowledged the error code should be provided. Here
are possible error codes:

  • 4004 - booking cannot be acknowledged. The reason is provided in the msg field.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required
≥ 1

Property ID on the Cloudbeds channel manager

string
required

Username, login or property ID on the OTA

string
required

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

string
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.

string
required
^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

Request reference ID, used for debugging and support requests.

string
required

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

string
required
^[a-z0-9]+$

OTA ID as given by Cloudbeds

string
enum
required
Allowed:
string
required

OTA booking ID of the booking to be acknowledged.

integer
≥ 1

Identifies which BookingCreate delivery is being acknowledged. One of the acknowledgement_ids returned in the response to that callback. Only present for bookings delivered through BookingCreate; omitted for bookings we retrieved with GetBookingList.

string | null

The version you returned for this booking in the GetBookingList response, passed back unchanged. null if you did not supply one, or if the booking reached us through the BookingCreate callback rather than being pulled.

string | null

Cloudbeds' own booking ID for the imported booking. null when the booking was acknowledged without being imported — for example a booking whose departure date has already passed, which is acknowledged so that it is not delivered again.

Response

Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json