Booking Settings
Define a property's booking window and default availability.
Overview
You can use a combination of the Update listings availability settings and Update a listing endpoints to control your property's default availability and booking lead time.
Default Availability
Available Endpoints
Method | URL |
---|---|
PUT | /listings/{id}/availability-settings |
Key Parameters
Default availability is configured through a combination of the following parameters.
Body Parameters | Type | Description | Required |
---|---|---|---|
calendarRules | object | Contains the availability settings. | yes |
defaultAvailability | string | Must be: available or unavailable . | yes |
rentalPeriods | [object] | An array of date objects. It defines the dates the property is available for rent when it is unavailable by default. | |
from | string | The start date for the rental period. E.g. "2024-11-20" . | |
to | string | The end date for the rental period. E.g. "2025-01-08" . | |
bookingWindow | object | Defines how far ahead a guest can book. | |
defaultSettings | object | yes | |
days | number | The number of days ahead a guest can book. e.g., 180 |
When the property is available for bookings all year around, it should be available
by default and have a booking window. If the property is seasonal, it should be unavailable
by default with set rentalPeriods
.
Booking Lead Time
These parameters control the lead time for bookings:
Key Parameters
Body Parameters | Type | Description | Required |
---|---|---|---|
calendarRules | object | Contains the availability settings. | yes |
preparationTime | object | Allocated days to preparations before and between stays. | |
defaultSettings | object | ||
days | number | one (1 ) or two (2 )nights. | |
when | string | BEFORE , AFTER , or BEFORE_AND_AFTER a stay. | |
advanceNotice | object | Specify the number of days required in advance to book a stay. | |
defaultSettings | object | ||
hours | number | one, two, three, or seven days in hours. E.g., 72 | |
dynamicCheckin | object | [Pilot] Adjust the time between reservations to optimize occupancy. | |
defaultSettings | object | ||
days | number | The number of days after check-out. E.g., 1 . |
Default Check-in & Check-out Times
Use the listings endpoint to set your property's default check-in and check-out times.
Available Endpoints
Method | URL |
---|---|
PUT | /listings/{id} |
Key Parameters
Body Parameters | Type | Description | Required |
---|---|---|---|
defaultCheckOutTime | string | The property's default check-out time (HH:MM). E.g., "10:00" . | |
defaultCheckInTime | string | The property's default check-in time (HH:MM). E.g., "15:00" . | |
defaultCheckInEndTime | string | For Airbnb listings, you can implement a check-in window by setting an end time (HH:MM) for the check-in window. E.g., "12:00" . |
Length of Stay Limits
Specify the listing's default minimum and maximum stay limits.
Available Endpoints
Method | URL |
---|---|
PUT | /listings/{id} |
Key Parameters
Body Parameter | Type | Description | Required |
---|---|---|---|
terms | object | yes | |
minNights | number | The default minimum number of nights to qualify for a stay. E.g., 4 | yes |
maxNights | number | The maximum number of nights a stay can be booked for. E.g., 28 | yes |
Updated 21 days ago