---
title: "SetupProperty"
method: POST
path: "/SetupProperty"
tags: ["Connection"]
---

# SetupProperty

`POST /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.

## Request body

- object
  - `mya_property_id` integer, required — Property ID on the Cloudbeds channel manager
  - `ota_property_id` string, required — User ID on the OTA
  - `ota_property_password` string — Password on the OTA, if supported
  - `ota_property_sub_id` 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.
  - `guid` string, required — Request reference ID, used for debugging and support requests.
  - `shared_secret` string, required — Authentication between the OTA and the channel. Identical for all requests. Not to be shared with customers.
  - `ota_cid` string, required — OTA ID as given by Cloudbeds
  - `verb` 'SetupProperty', required
  - `RoomInfo` RoomInfo[] — 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.
    - `mya_room_id` integer, required — Room ID on the Cloudbeds channel manager
    - `units` integer, required — How many rooms of this type there are.
    - `beds` integer, required — Number people that can stay in this room.
    - `dormitory` boolean, required — If `true` it's a dormitory (shared room), `false` for private rooms.
    - `label` string, required — Short string that describes the room for displaying purposes.
    - `description` unknown, required

## Response `200`

SetupProperty

- ResponseSimple
  - `errors` object[] — Array of error objects. Required when `success` is `false`.
    - `id` integer, required — Error code. Check the "Error Codes" section of the specification for valid codes.
    - `msg` string — Optional error string to give more details about the error. Myallocator localises errors into different languages, so this field is generally ignored and only useful for debugging.
  - `success` true | false, required

---

[API](https://skmtc.net/cloudbeds/apis/cloudbeds-api.md) · [All operations](https://skmtc.net/cloudbeds/apis/cloudbeds-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cloudbeds/cloudbeds-api/versions/2faa857793e8/schema)