Update Booking Settings
This endpoint updates the Airbnb booking settings, including guest controls, check-in/out times, and cancellation policies, for a specified listing.
Endpoint
POST
Header
app-id
string
Yes
Your application ID. Required for authentication.
Authorization
string
Yes
Your API key. for authorization. Required for authentication.
Content-Type
string
Yes
Must be set to application/json.
Attributes
hotelid alphanumeric (Required)
Specifies the required node hotelid contains the IT provider's hotel id for which the provider wishes to add mapping information.
channelhotelid alphanumeric (Required)
Specifies the unique hotel ID used in the external distribution channel or PMS (Property Management System).
listingid numeric (Required)
listing id of the property allocated by airbnb.
cancellation_policy_settings object (Optional)
Contains the cancellation policy related settings.
cancellation_policy_category enum (Optional)
Cancellation policy for the listings which can be set within booking settings. Obtain the required enum values through the Master Data API.
lts_cancellation_policy_id enum (Optional)
Id of the cancellation policy. Allowed: CANCEL_LONG_TERM_FAIR , CANCEL_LONG_TERM_WITH_GRACE_PERIOD
eligible_cancellation_policies array of strings (Optional)
array of supported or eligible cancellation policies.
non_refundable_price_factor numeric (Optional)
Non-refundable discount in percentage.
check_in_time_start string (Optional)
Earliest time a guest can check in—must be an hour between “8”, “9”, “10”....“23”, or “FLEXIBLE”.
check_in_time_end string (Optional)
Latest time a guest can check in—must be an hour between “9”, “10”, “11”....“27”, or "FLEXIBLE".
check_out_time string (Optional)
Latest time a guest can check out—must be an hour between 0 and 23.
instant_booking_allowed_category enum (Optional)
The category of guests that can create Instant Book reservations. Guests who don’t meet these requirements can send booking requests.
Allowed: everyone, well_reviewed_guests
instant_book_welcome_message string (Optional)
Require guests to read and respond to a message before they confirm their reservation. Maximum 400 characters.
listing_expectations_for_guests array of objects (Optional)
Expectations about the Host’s space that guests must agree to before booking.
type enum (Required)
The type of the expectation the guests must agree to. Obtain the required enum values through the Master Data API.
added_details string (Optional)
Additional details of the expectation. Max 300 characters.
guest_controls object (Optional)
Rules regarding pets, children, events, and smoking in the Host's space.
allows_children_as_host boolean (Required)
Specify if the listing is suitable for children (2-12 years).
allows_infants_as_host boolean (Required)
Specify if the listing is suitable for infants (under 2 years).
children_not_allowed_details string (Optional)
Provide details regarding why the property may not be safe for kids.
allows_smoking_as_host boolean (Required)
Specify if smoking is allowed.
allows_pets_as_host boolean (Required)
Specify if pets are allowed. Note: You must remove PASS_THROUGH_PET_FEE type fees (If set) from the listing before you can disable allows_pets_as_host.
pet_capacity numeric (Optional)
Maximum number of pets that the listing can accommodate. If pets are allowed, the value must be an integer from 1 to 5—default is 5. If pets are not allowed, the value must be 0.
allows_events_as_host boolean (Required)
Specify if parties or events are allowed.
Request
Response
Success Response
Success Response - Body Elements
Data object
Contains the updated booking setting information returned by the API.
booking_setting object
Holds all booking-related configuration for the listing.
guest_controls object
Defines rules for which guests or activities are allowed at the property.
allows_infants_as_host boolean
Indicates if infants are allowed at the property.
allows_events_as_host boolean
Indicates if parties or events are allowed.
allows_children_as_host boolean
Indicates if children are allowed.
pet_capacity integer
Maximum number of pets allowed.
allows_pets_as_host boolean
Indicates if pets are allowed at the property.
allows_smoking_as_host boolean
Indicates if smoking is allowed at the property.
check_out_time integer
The designated check-out time for guests.
instant_book_welcome_message string
Welcome message sent to guests for instant bookings.
cancellation_policy_settings object
Contains cancellation policy configuration details.
cancellation_policy_category string
The selected cancellation policy category.
eligible_cancellation_policies array
List of available cancellation policies that can be applied.
lts_cancellation_policy_id string
Long-term stay cancellation policy identifier.
instant_booking_allowed_category string
Indicates who is allowed to instantly book the listing.
listing_expectations_for_guests array
List of expectations that guests must agree to before booking.
type string
Specifies the type of guest expectation.
check_in_time_start string
Earliest time a guest can check in.
check_in_time_end string
Latest time a guest can check in.
listing_id string
Listing ID of the property.
Message string
A descriptive message indicating successful update of booking settings.
Error Response
Error Response - Body Elements
Status string
Indicates the result of the API call.
Will be always "Fail" in case of an error response.
Errors object
The response error, the root element.
Code string
Specific error code that helps identify the type of error.
For example: "400" indicates a bad request.
ShortText string
A short description of the error.
Message string
The message in the response.
Last updated
Was this helpful?