v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Connection

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.

post/SetupProperty

Request body

mya_property_idinteger required

Property ID on the Cloudbeds channel manager

ota_property_idstring required

User ID on the OTA

ota_property_passwordstring

Password on the OTA, if supported

ota_property_sub_idstring

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

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'SetupProperty' required

Response

SetupProperty

successtrue | false required