SetupProperty

Check/verify/validate the credentials stored in ota_property_id and
ota_property_password. If the credentials are invalid return with error
ID 1001. If the connection needs to be enabled from the OTA side first
return with error ID 1002.

On Cloudbeds the hotel will go to the OTA setup by selecting the OTA.
There the user will be prompted to put in the credentials
(ota_property_id and ota_property_password), which are provided by your
OTA. Both ota_property_id and ota_property_password will be retained by
us and passed in every call. Should you not need two identification fields
please let us know and we can set it to only ask for ota_property_id.
In that case, the hotel can self-serve as long as no other property is
already using the same ota_property_id. If the ID is already in use by
another property, our customer support team will verify that the new
connection is allowed before enabling it, to prevent a hotel from entering
someone else's credentials.

Implementation suggestions: ota_property_id should typically be a username
or hotel ID on your OTA. The ota_property_password is typically a
password used by the hotel to access your OTA's extranet or a token
specifically for a channel manager.

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

User ID on the OTA

string

Password on the OTA, if supported

string

If multiple properties are supported for a set of ota_property_id and ota_property_password, this is the ID identifying a specific property.

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:
RoomInfo
array of objects

This list of rooms will only be returned if enabled for the OTA by Cloudbeds. By default this is not present. It's only necessary for deep integrations or situations where the OTA plans to automatically/create destroy rooms using the Cloudbeds configuration. In a normal integration this isn't very usual.

RoomInfo
Response

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