Rentals Contents Overrides

  1. Overview
  2. List rentals contents overrides
  3. Get a single rentals content override
  4. Create a new rentals content override
  5. Update a rentals content override
  6. Destroy a rentals content override

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

Name Type Read/Write Description
account Integer Read Account’s ID related to the Rentals Contents Override
application Integer Read Application’s ID related to the Rentals Contents Override
rental Integer Read Rental’s ID related to the Rentals Contents Override
id Integer Read Rentals Contents Override’s ID.
description Object Read Description override for related application, list of locales described in enums section.
headline Object Read Headline override for related application, list of locales described in enums section.
summary Object Read Summary override for related application, list of locales described in enums section.
created_at Time Read Rentals Contents Override’s create time.
updated_at Time Read Rentals Contents Override’s update time.
Name Type Read/Write Description Constraints
account Integer Read Account’s ID related to the Rentals Contents Override  
application Integer Read Application’s ID related to the Rentals Contents Override  
rental Integer Read Rental’s ID related to the Rentals Contents Override  
id Integer Read Rentals Contents Override’s ID.  
application_id Integer Write Application’s Id related to the Rentals Contents Override. Required on create
rental_id Integer Write Rental’s ID related to the Rentals Contents Override. Required on create
description Object Read/Write Description override for related application, list of locales described in enums section. Maximum length: 10 000 (unless customized)
headline Object Read/Write Headline override for related application, list of locales described in enums section. Maximum length: 75 (unless customized)
summary Object Read/Write Summary override for related application, list of locales described in enums section. Maximum length: 150 (unless customized)
created_at Time Read Rentals Contents Override’s create time.  
updated_at Time Read Rentals Contents Override’s update time.  

List rentals contents overrides

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

GET /rentals_contents_overrides

Response

{
  "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": [
    {
      "id": 3,
      "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."
      },
      "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."
      },
      "created_at": "2023-12-11T08:26:27Z",
      "updated_at": "2023-12-11T08:26:27Z",
      "links": {
        "application": 1,
        "rental": 2
      }
    }
  ],
  "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

{
  "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": [
    {
      "id": 3,
      "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."
      },
      "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."
      },
      "created_at": "2023-12-11T08:26:27Z",
      "updated_at": "2023-12-11T08:26:27Z",
      "links": {
        "application": 1,
        "rental": 2
      }
    }
  ],
  "meta": {
  }
}

Create a new rentals content override

Creates a rentals content override for given rental.

POST /rentals_contents_overrides

Example JSON request

{
  "rentals_contents_overrides": [
    {
      "application_id": 1,
      "description_en": "First class Villa for 8 people with private pool. Situated in a pleasant residential area.",
      "description_fr": "Villa de première classe pour 8 personnes avec piscine privée. Situé dans un quartier résidentiel agréable.",
      "headline_en": "Villa in Nevache, France",
      "headline_fr": "Villa à Névache, France",
      "rental_id": 2,
      "summary_en": "Great value. A place to enjoy peace and tranquility, away from mass tourism.",
      "summary_fr": "Grande valeur. Profitez d'un cadre agréable en plein nature."
    }
  ]
}

Response

{
  "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": [
    {
      "id": 3,
      "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."
      },
      "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."
      },
      "created_at": "2023-12-11T08:26:27Z",
      "updated_at": "2023-12-11T08:26:27Z",
      "links": {
        "application": 1,
        "rental": 2
      }
    }
  ],
  "meta": {
  }
}

Update a rentals content override

Returns an updated rentals content override identified by ID.

PUT /rentals_contents_overrides/:rentals_content_override_id

Example JSON request

{
  "rentals_contents_overrides": [
    {
      "description_en": "First class Villa for 8 people with private pool. Situated in a pleasant residential area.",
      "description_fr": "Villa de première classe pour 8 personnes avec piscine privée. Situé dans un quartier résidentiel agréable.",
      "headline_en": "Villa in Nevache, France",
      "headline_fr": "Villa à Névache, France",
      "summary_en": "Great value. A place to enjoy peace and tranquility, away from mass tourism.",
      "summary_fr": "Grande valeur. Profitez d'un cadre agréable en plein nature."
    }
  ]
}

Response

{
  "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": [
    {
      "id": 3,
      "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."
      },
      "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."
      },
      "created_at": "2023-12-11T08:26:27Z",
      "updated_at": "2023-12-11T08:26:27Z",
      "links": {
        "application": 1,
        "rental": 2
      }
    }
  ],
  "meta": {
  }
}

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