Skip to main content

Rentals Contents Overrides

Overview​

This resource represents the Rental Content Overrides which allow different channels (other Applications) to have customized content for fields like headline, summary, description, which also allows to bypass the length validation that is normally applied for these fields in Rentals endpoint.

Note: An Application needs to be configured in a way that content overrides are permitted. Most likely you will need to reach out to us and ask for this feature to be enabled for your Application or if you want to customize the maximum length for the overridable fields.

Parameters​

NameTypeRead/WriteDescription
accountIntegerReadAccount's ID related to the Rentals Contents Override
applicationIntegerReadApplication's ID related to the Rentals Contents Override
rentalIntegerReadRental's ID related to the Rentals Contents Override
idIntegerReadRentals Contents Override's ID.
descriptionObjectReadDescription override for related application, list of locales described in enums section.
headlineObjectReadHeadline override for related application, list of locales described in enums section.
summaryObjectReadSummary override for related application, list of locales described in enums section.
created_atTimeReadRentals Contents Override's create time.
updated_atTimeReadRentals Contents Override's update time.

List rentals contents overrides​

List all rentals contents overrides for a given account(s).

GET /rentals_contents_overrides
response.json
{
  "links": {
    "rentals_contents_overrides.application": "https://www.bookingsync.com/api/v3/applications/{rentals_contents_overrides.application}",
    "rentals_contents_overrides.rental": "https://www.bookingsync.com/api/v3/rentals/{rentals_contents_overrides.rental}"
  },
  "rentals_contents_overrides": [
    {
      "links": {
        "application": 1,
        "rental": 2
      },
      "id": 3,
      "headline": {
        "en": "Villa in Nevache, France",
        "fr": "Villa à Névache, France"
      },
      "summary": {
        "en": "Great value. A place to enjoy peace and tranquility, away from mass tourism.",
        "fr": "Grande valeur. Profitez d'un cadre agréable en plein nature."
      },
      "description": {
        "en": "First class Villa for 8 people with private pool. Situated in a pleasant residential area.",
        "fr": "Villa de première classe pour 8 personnes avec piscine privée. Situé dans un quartier résidentiel agréable."
      },
      "created_at": "2025-03-31T17:52:12.402Z",
      "updated_at": "2025-04-07T17:52:12.402Z"
    }
  ],
  "meta": {}
}

Get a single rentals content override​

Returns a single rentals content override identified by ID.

GET /rentals_contents_overrides/:rentals_content_override_id
response.json
{
  "links": {
    "rentals_contents_overrides.application": "https://www.bookingsync.com/api/v3/applications/{rentals_contents_overrides.application}",
    "rentals_contents_overrides.rental": "https://www.bookingsync.com/api/v3/rentals/{rentals_contents_overrides.rental}"
  },
  "rentals_contents_overrides": [
    {
      "links": {
        "application": 1,
        "rental": 2
      },
      "id": 3,
      "headline": {
        "en": "Villa in Nevache, France",
        "fr": "Villa à Névache, France"
      },
      "summary": {
        "en": "Great value. A place to enjoy peace and tranquility, away from mass tourism.",
        "fr": "Grande valeur. Profitez d'un cadre agréable en plein nature."
      },
      "description": {
        "en": "First class Villa for 8 people with private pool. Situated in a pleasant residential area.",
        "fr": "Villa de première classe pour 8 personnes avec piscine privée. Situé dans un quartier résidentiel agréable."
      },
      "created_at": "2025-03-31T17:52:12.403Z",
      "updated_at": "2025-04-07T17:52:12.403Z"
    }
  ],
  "meta": {}
}

Create a new rentals content override​

Creates a rentals content override for given rental.

POST /rentals_contents_overrides

Update a rentals content override​

Returns an updated rentals content override identified by ID.

PUT /rentals_contents_overrides/:rentals_content_override_id

Destroy a rentals content override​

Required OAuth scope: :rentals_write

Returns empty response with 204 No Content status code on success.

DELETE /rentals_contents_overrides/:rentals_content_override_id