Overview

Introduction Changelog Requirements Libraries Authorization Testing the Authorization Enumerables

Endpoints

Accounts Amenities Applications Availabilities Bathrooms Bedrooms Booking Discount Codes Booking Discount Code Usages Bookings Booking Comments Bookings Fees Bookings Payments Bookings Tags Bookings Taxes Change Overs Clients Contacts Destinations Fees Fees Taxes Hosts Inbox Attachments Inbox Conversations Inbox Messages Inbox Participants Inquiries Living Rooms LOS Records Me Mid Term Rate Maps Nightly Rate Maps Payment Gateways Payments Periods Photos Rates Rates Rules Rates Tables Rentals Rental Contacts Rental Agreements Rental Cancelation Policies Rental Cancelation Policy Items Rentals Amenities ! Rentals Contents Overrides Rentals Fees Rental Link Groups Rental Links Rentals Tags Rentals Taxes Rental URLs Reviews Seasons Sources Special Offers Taxes Tax Rules
  1. Overview
  2. List rental links
  3. Get a single rental link

Overview

This resource represents Rental Links which are managed via Rental Link Groups.

The purpose of the Rental Links is to mirror the availabilities between two Rentals - if there is a link between Rental A and Rental B, creating (or canceling) a Booking for either of them will result in creating/canceling a “mirrored” Booking on the other Rental.

Parameters

Name Type Read/Write Description
account Integer Read Account’s ID related to the Rental link
rental_link_group Integer Read Rental link Group’s ID related to the Rental link
source_rental Integer Read Rental’s ID (as source of the link) related to the Rental link
destination_rental Integer Read Rental’s ID (as destination of the link) related to the Rental link
id Integer Read Rental link’s ID.
kind String Read Rental link’s kind, list of rental link’s rate kinds described in enums section.
created_at Time Read Rental link’s create time.
updated_at Time Read Rental link’s update time.

List all rental link for a given account(s).

GET /rental_links

Response

{
  "links": {
    "rental_links.account": "https://www.bookingsync.com/api/v3/accounts/{rental_links.account}",
    "rental_links.destination_rental": "https://www.bookingsync.com/api/v3/rentals/{rental_links.destination_rental}",
    "rental_links.rental_link_group": "https://www.bookingsync.com/api/v3/rental_link_groups/{rental_links.rental_link_group}",
    "rental_links.source_rental": "https://www.bookingsync.com/api/v3/rentals/{rental_links.source_rental}"
  },
  "rental_links": [
    {
      "id": 1,
      "kind": "mirror",
      "created_at": "2023-12-11T08:26:25Z",
      "updated_at": "2023-12-11T08:26:25Z",
      "links": {
        "account": 1,
        "destination_rental": 2,
        "rental_link_group": 1,
        "source_rental": 3
      }
    }
  ],
  "meta": {
  }
}

Returns a single rental link identified by ID.

GET /rental_links/:rental_link_id

Response

{
  "links": {
    "rental_links.account": "https://www.bookingsync.com/api/v3/accounts/{rental_links.account}",
    "rental_links.destination_rental": "https://www.bookingsync.com/api/v3/rentals/{rental_links.destination_rental}",
    "rental_links.rental_link_group": "https://www.bookingsync.com/api/v3/rental_link_groups/{rental_links.rental_link_group}",
    "rental_links.source_rental": "https://www.bookingsync.com/api/v3/rentals/{rental_links.source_rental}"
  },
  "rental_links": [
    {
      "id": 1,
      "kind": "mirror",
      "created_at": "2023-12-11T08:26:25Z",
      "updated_at": "2023-12-11T08:26:25Z",
      "links": {
        "account": 1,
        "destination_rental": 2,
        "rental_link_group": 1,
        "source_rental": 3
      }
    }
  ],
  "meta": {
  }
}