Skip to main content

Rental Link Groups

Overview​

This resource represents Rental Link Groups which is a way of establishing links between Rentals - creating or deleting a Rental Link Group results creating or deleting Rental Links.

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​

NameTypeRead/WriteDescription
accountIntegerReadAccount's ID related to the Rental Link Group
rentalsArrayReadRentals' IDs related to the Rental Link Group
rental_linksArrayReadRental Links' ID related to the Rental Link Group
idIntegerReadRental link group's ID.
rental_namesStringReadRentals' names associated with given rental link group's
created_atTimeReadRental link group's create time.
updated_atTimeReadRental link group's update time.

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

GET /rental_link_groups
response.json
{
  "links": {
    "rental_link_groups.account": "https://www.bookingsync.com/api/v3/accounts/{rental_link_groups.account}",
    "rental_link_groups.rental_links": "https://www.bookingsync.com/api/v3/rental_links/{rental_link_groups.rental_links}",
    "rental_link_groups.rentals": "https://www.bookingsync.com/api/v3/rentals/{rental_link_groups.rentals}"
  },
  "rental_link_groups": [
    {
      "links": {
        "account": 1,
        "rental_links": [
          1,
          2
        ],
        "rentals": [
          1,
          2
        ]
      },
      "id": 1,
      "rental_names": "Rental 1, Rental 2",
      "created_at": "2025-03-31T17:52:12.052Z",
      "updated_at": "2025-04-07T17:52:12.052Z"
    }
  ],
  "meta": {}
}

Returns a single rental link group identified by ID.

GET /rental_link_groups/:rental_link_group_id
response.json
{
  "links": {
    "rental_link_groups.account": "https://www.bookingsync.com/api/v3/accounts/{rental_link_groups.account}",
    "rental_link_groups.rental_links": "https://www.bookingsync.com/api/v3/rental_links/{rental_link_groups.rental_links}",
    "rental_link_groups.rentals": "https://www.bookingsync.com/api/v3/rentals/{rental_link_groups.rentals}"
  },
  "rental_link_groups": [
    {
      "links": {
        "account": 1,
        "rental_links": [
          1,
          2
        ],
        "rentals": [
          1,
          2
        ]
      },
      "id": 1,
      "rental_names": "Rental 1, Rental 2",
      "created_at": "2025-03-31T17:52:12.053Z",
      "updated_at": "2025-04-07T17:52:12.053Z"
    }
  ],
  "meta": {}
}

Creates a rental link group for given rental.

POST /rental_link_groups
request.json
{
  "rental_link_groups": [
    {
      "rental_ids": [
        1,
        2
      ]
    }
  ]
}
response.json
{
  "links": {
    "rental_link_groups.account": "https://www.bookingsync.com/api/v3/accounts/{rental_link_groups.account}",
    "rental_link_groups.rental_links": "https://www.bookingsync.com/api/v3/rental_links/{rental_link_groups.rental_links}",
    "rental_link_groups.rentals": "https://www.bookingsync.com/api/v3/rentals/{rental_link_groups.rentals}"
  },
  "rental_link_groups": [
    {
      "links": {
        "account": 1,
        "rental_links": [
          1,
          2
        ],
        "rentals": [
          1,
          2
        ]
      },
      "id": 1,
      "rental_names": "Rental 1, Rental 2",
      "created_at": "2025-03-31T17:52:12.054Z",
      "updated_at": "2025-04-07T17:52:12.054Z"
    }
  ],
  "meta": {}
}

Required OAuth scope: rentals_write

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

DELETE /rental_link_groups/:rental_link_group_id