Bedrooms
Overview
This resource represents the rental's bedrooms. This resource is mostly static information used for presentational purposes.
Parameters
- OAuth Scopes:
- public
- rentals_write
| Name | Type | Read/Write | Description |
|---|---|---|---|
| account | Integer | Read | Account's ID related to the Bedroom |
| rental | Integer | Read | Rental's ID related to the Bedroom |
| id | Integer | Read | Bedroom's id. |
| name | Object | Read | Bedroom's name, list of locales described in enums section. |
| kingsize_beds_count | Integer | Read | Bedroom's number of kingsize beds. |
| queensize_beds_count | Integer | Read | Bedroom's number of queensize beds. |
| double_beds_count | Integer | Read | Bedroom's number of double beds. |
| single_beds_count | Integer | Read | Bedroom's number of single beds. |
| bunk_beds_count | Integer | Read | Bedroom's number of bunk beds. |
| sofa_beds_count | Integer | Read | Bedroom's number of sofa beds. |
| crib_beds_count | Integer | Read | Bedroom's number of crib beds. |
| rollaway_beds_count | Integer | Read | Bedroom's number of rollaway beds. |
| created_at | Time | Read | Bedroom's create time. |
| updated_at | Time | Read | Bedroom's update time. |
| Name | Type | Read/Write | Description | Constraints |
|---|---|---|---|---|
| account | Integer | Read | Account's ID related to the Bedroom | |
| rental | Integer | Read | Rental's ID related to the Bedroom | |
| id | Integer | Read | Bedroom's id. | |
| name | Object | Read | Bedroom's name, list of locales described in enums section. | |
| name_locale | String | Write | Bedroom's name, used in write operations. Replace the locale with one of the locales described in enums section (e.g. name_en). Multiple of these attributes could be passed in the same operation, as long as they each have a unique locale (e.g name_en and name_fr) | Required for Account's default locale, maximum length: 25 |
| kingsize_beds_count | Integer | Read/Write | Bedroom's number of kingsize beds. | integer only, greater than or equal to: 0 |
| queensize_beds_count | Integer | Read/Write | Bedroom's number of queensize beds. | integer only, greater than or equal to: 0 |
| double_beds_count | Integer | Read/Write | Bedroom's number of double beds. | integer only, greater than or equal to: 0 |
| single_beds_count | Integer | Read/Write | Bedroom's number of single beds. | integer only, greater than or equal to: 0 |
| bunk_beds_count | Integer | Read/Write | Bedroom's number of bunk beds. | integer only, greater than or equal to: 0 |
| sofa_beds_count | Integer | Read/Write | Bedroom's number of sofa beds. | integer only, greater than or equal to: 0 |
| crib_beds_count | Integer | Read/Write | Bedroom's number of crib beds. | integer only, greater than or equal to: 0 |
| rollaway_beds_count | Integer | Read/Write | Bedroom's number of rollaway beds. | integer only, greater than or equal to: 0 |
| created_at | Time | Read | Bedroom's create time. | |
| updated_at | Time | Read | Bedroom's update time. |
List bedrooms
List all bedrooms for a given account.
GET /bedrooms
- OAuth Scopes:
- public
response.json
{
"links": {
"bedrooms.rental": "https://www.bookingsync.com/api/v3/rentals/{bedrooms.rental}"
},
"bedrooms": [
{
"links": {
"rental": 1
},
"id": 1,
"name": {
"en": "bedroom"
},
"kingsize_beds_count": 0,
"queensize_beds_count": 0,
"double_beds_count": 1,
"single_beds_count": 2,
"bunk_beds_count": 0,
"sofa_beds_count": 1,
"crib_beds_count": 0,
"rollaway_beds_count": 0,
"created_at": "2025-10-29T10:49:37.672Z",
"updated_at": "2025-11-05T10:49:37.672Z"
}
],
"meta": {}
}
Get a single bedroom
Returns a single bedroom identified by ID.
GET /bedrooms/:bedroom_id
- OAuth Scopes:
- public
response.json
{
"links": {
"bedrooms.rental": "https://www.bookingsync.com/api/v3/rentals/{bedrooms.rental}"
},
"bedrooms": [
{
"links": {
"rental": 1
},
"id": 1,
"name": {
"en": "bedroom"
},
"kingsize_beds_count": 0,
"queensize_beds_count": 0,
"double_beds_count": 1,
"single_beds_count": 2,
"bunk_beds_count": 0,
"sofa_beds_count": 1,
"crib_beds_count": 0,
"rollaway_beds_count": 0,
"created_at": "2025-10-29T10:49:37.675Z",
"updated_at": "2025-11-05T10:49:37.675Z"
}
],
"meta": {}
}
Create a new bedroom
Creates a bedroom for given rental.
POST /rentals/:rental_id/bedrooms
- OAuth Scopes:
- rentals_write
request.json
{
"bedrooms": [
{
"name_en": "bedroom",
"kingsize_beds_count": 0,
"queensize_beds_count": 0,
"double_beds_count": 1,
"single_beds_count": 2,
"bunk_beds_count": 0,
"sofa_beds_count": 1,
"crib_beds_count": 0,
"rollaway_beds_count": 0
}
]
}
response.json
{
"links": {
"bedrooms.rental": "https://www.bookingsync.com/api/v3/rentals/{bedrooms.rental}"
},
"bedrooms": [
{
"links": {
"rental": 1
},
"id": 1,
"name": {
"en": "bedroom"
},
"kingsize_beds_count": 0,
"queensize_beds_count": 0,
"double_beds_count": 1,
"single_beds_count": 2,
"bunk_beds_count": 0,
"sofa_beds_count": 1,
"crib_beds_count": 0,
"rollaway_beds_count": 0,
"created_at": "2025-10-29T10:49:37.680Z",
"updated_at": "2025-11-05T10:49:37.680Z"
}
],
"meta": {}
}
Update a bedroom
Returns an updated bedroom identified by ID.
PUT /bedrooms/:bedroom_id
- OAuth Scopes:
- rentals_write
request.json
{
"bedrooms": [
{
"name_en": "bedroom",
"kingsize_beds_count": 0,
"queensize_beds_count": 0,
"double_beds_count": 1,
"single_beds_count": 2,
"bunk_beds_count": 0,
"sofa_beds_count": 1,
"crib_beds_count": 0,
"rollaway_beds_count": 0
}
]
}
response.json
{
"links": {
"bedrooms.rental": "https://www.bookingsync.com/api/v3/rentals/{bedrooms.rental}"
},
"bedrooms": [
{
"links": {
"rental": 1
},
"id": 1,
"name": {
"en": "bedroom"
},
"kingsize_beds_count": 0,
"queensize_beds_count": 0,
"double_beds_count": 1,
"single_beds_count": 2,
"bunk_beds_count": 0,
"sofa_beds_count": 1,
"crib_beds_count": 0,
"rollaway_beds_count": 0,
"created_at": "2025-10-29T10:49:37.684Z",
"updated_at": "2025-11-05T10:49:37.684Z"
}
],
"meta": {}
}
Destroy a bedroom
Required OAuth scope: :rentals_write
Returns an empty response with 204 No Content status code on success.
DELETE /bedrooms/:bedroom_id