Skip to content
/Property Description API

Property API (1.0)

Use the Property API to create or update a property and its settings; check and update property status; as well as create or update property description.

Download OpenAPI description
property-details-api-specification.json
property-details-api-specification.yaml
Overview
URL
https://connect.booking.com
Connectivity Team
connectivity@booking.com
Languages
Servers
Test static response
https://developers.booking.com/_mock/connectivity/docs/openapispecs/property-details-api/property-details-api-specification
Test using live endpoint
https://supply-xml.booking.com/property-api

Property Details API

Create, update and retrieve property details

Operations

Property Settings API

Add, update or retrieve property settings

Operations

Property Status API

Check if a property is ready to open; open or close a property

Operations

Property Description API

Create, update and retrieve property description

Operations

Get existing property description

Request

Path
propertyIdinteger(int32)required
curl -i -X GET \
  'https://developers.booking.com/_mock/connectivity/docs/openapispecs/property-details-api/property-details-api-specification/properties/{propertyId}/description'

Responses

default response

Bodyapplication/json
dataobject(PropertyDescription)
warningsArray of objects(ApiErrorOTA)
errorsArray of objects(ApiErrorOTA)
metaobject(ResponseMeta)
Response
application/json
{
  "data": {
    "text": "string",
    "language_code": "strin",
    "last_update": "string"
  },
  "warnings": [
    { … }
  ],
  "errors": [
    { … }
  ],
  "meta": {
    "ruid": "string"
  }
}

Create or update property description

Request

Path
propertyIdinteger(int32)required
Bodyapplication/json
textstringrequired
language_codestring[ 2 .. 5 ] characters
last_updatestring
curl -i -X PUT \
  'https://developers.booking.com/_mock/connectivity/docs/openapispecs/property-details-api/property-details-api-specification/properties/{propertyId}/description' \
  -H 'Content-Type: application/json' \
  -d '{
    "text": "string",
    "language_code": "strin",
    "last_update": "string"
  }'

Responses

default response

Bodyapplication/json
dataobject
warningsArray of objects(ApiErrorOTA)
errorsArray of objects(ApiErrorOTA)
metaobject(ResponseMeta)
Response
application/json
{
  "data": {},
  "warnings": [
    { … }
  ],
  "errors": [
    { … }
  ],
  "meta": {
    "ruid": "string"
  }
}

Delete existing property description

Request

Path
propertyIdinteger(int32)required
curl -i -X DELETE \
  'https://developers.booking.com/_mock/connectivity/docs/openapispecs/property-details-api/property-details-api-specification/properties/{propertyId}/description'

Responses

default response

Bodyapplication/json
dataobject
warningsArray of objects(ApiErrorOTA)
errorsArray of objects(ApiErrorOTA)
metaobject(ResponseMeta)
Response
application/json
{
  "data": {},
  "warnings": [
    { … }
  ],
  "errors": [
    { … }
  ],
  "meta": {
    "ruid": "string"
  }
}

About Try it

Learn how to effectively use the Try it feature in the Property API documentation.

Use the Try it feature to send test request examples to the API endpoints directly from the developer portal and depending on the selected environment either see static, pre-built responses or dynamic responses from a test property.