Create / Update Property Settings

This endpoint allows partners to create and update property settings for their accommodations on the Booking.com platform. It provides a comprehensive set of configurable options, including payment policies, guest requirements, and property rules, enabling partners to tailor their offerings effectively to meet their business needs.

Endpoint

POST 

https://connect-sandbox.su-api.com/SUAPI/jservice/bdc/property/settings/set

Header

-app-id: YOUR_APP_ID
Authorization: YOUR_API_KEY
Content-Type:application/json
Header
Type
Required
Description

app-id

string

Yes

Your application ID. Required for authentication.

Authorization

string

Yes

Your API key for authorization.

Content-Type

string

Yes

Must be set to application/json.

Attributes

hotel_id string (Required)

The unique property ID as assigned by the provider upon creation of the property.

channel_hotel_id string (Required)

The unique id for the hotel on the specific channel.

property_settings object (Optional)

Contains multiple various settings related to the property.

require_cvc boolean (Optional)

Specifies whether the guest needs to provide CVC details for the booking.

Default: false

view_cc_details boolean (Optional)

Specifies whether a trusted property can view the guest's credit card details on Extranet.

Default: false

curfew object (Optional)

Contains curfew settings for the property.

Curfew start and end cannot be overlapped with property check-in and check-out times.

enabled boolean (Required)

Specifies whether the property has curfew time enabled.

start boolean (Optional)

Time when curfew starts. Accepts the format: HH:MM.

Required if enabled=true.

end string (Optional)

Time when curfew ends. Accepts the format: HH:MM.

Required if enabled=true.

require_booker_address boolean (Optional)

Specifies whether the guests must provide a contact address.

Default: false

require_booker_phone_number boolean (Optional)

Specifies whether the guests must provide a contact telephone number.

Default: false

age_restriction object (Optional)

Contains whether there is an age limit to check-in.

enabled boolean (Required)

Specify whether age restriction is enabled

min boolean (Optional)

Specifies the minimum allowed age for guests to check-in. Allowed age range: 18-99.

Required if enabled=true.

max boolean (Optional)

Specifies the maximum allowed age for guests to check-in. Allowed age range: 18-99.

Required if enabled=true.

auto_replenish boolean (Optional)

Specifies if property is enabled to auto-replenish and is used to make a room available to sell again after a cancellation.

Default: true

replenish_closed_rooms boolean (Optional)

Reopen closed rooms after a cancellation. This will open a closed room after a cancellation is received.

Default: true.

This option will only work if auto_replenish=true.

long_stay object (Optional)

Contains whether property accepts a stay longer than 30 nights.

enabled boolean (Required)

Specifies whether the property has a long stay option enabled.

max_length_of_stay integer (Optional)

Specifies the maximum number of days allowed to stay at the property.

Default: 90 (If long stay option is enabled.)

Possible values are:

  • 45

  • 60

  • 75

  • 90

pricing_type enum (Optional)

Specifies the property's pricing type.

Default: Standard

Possible values are:

  • Standard

  • OBP

In case of pricing_type = OBP, see Create / Update Property Settings - Specific Settings.

allow_smoking boolean (Optional)

Specifies whether the property allows smoking.

Default: true

pets object (Optional)

Contains settings related to pets policy.

pets_allowed enum (Required)

Specifies whether pets are allowed at the property.

Possible values are:

  • PETS_ALLOWED

  • PETS_NOT_ALLOWED

  • PETS_ALLOWED_ON_REQUEST

pets_price_type enum (Optional)

Specifies pets price type option for the property.

Possible values are:

  • FREE

  • CHARGES_MAY_APPLY

damage_policy object (Optional)

Contains settings related to damage policy.

amount double (Required)

Specifies the amount on which the damage deposit or programme is applicable for.

Default: 0.0

currency string (Optional)

Specifies the currency in which the claim and limit occurs.

Default is Property Currency if not specified.

policy_type enum (Required)

Specifies the policy that is applicable.

Default: NONE

Possible values are:

  • HANDLED_BY_PROPERTY- Guests pay you a damage deposit directly.

  • HANDLED_BY_BOOKING_COM- Guests only pay if they cause damage during their stay, facilitated by Booking.com

  • NONE

damage_programme_terms_agreed boolean (Optional)

Specifies if you agree to the terms for the damage programme.

Default: false

Required if you are applying forHANDLED_BY_BOOKING_COM.

The value of this parameter is determined by the terms of the damage programme, which can be retrieved through the Retrieve Property Settings Damage Programme endpoint.

  • Set to true if you agree to the terms.

  • Set to false if you do not agree to the terms.

You can only enroll if you agree to the terms which are provided to you.

collection_mode enum (Optional)

Specifies how you would collect damage deposit.

Only applicable forHANDLED_BY_PROPERTY.

Possible values are:

  • CASH

  • CREDIT_CARD

  • PAYPAL

  • BANK_TRANSFER

  • OTHER

collection_when enum (Optional)

Specifies when you would collect the damage deposit.

Only applicable for HANDLED_BY_PROPERTY.

If collection_mode is CASH then only ON_ARRIVAL is allowed for collection_when.

Possible values are:

  • ON_ARRIVAL

  • SEVEN_DAYS_BEFORE_ARRIVAL

  • FOURTEEN_DAYS_BEFORE_ARRIVAL

return_mode enum (Optional)

Specifies how you would return the damage deposit.

Only applicable for HANDLED_BY_PROPERTY.

Possible values are:

  • CASH

  • CREDIT_CARD

  • PAYPAL

  • BANK_TRANSFER

  • OTHER

return_when enum (Optional)

Specifies when you would return the damage deposit.

Only applicable for HANDLED_BY_PROPERTY.

If return_mode is CASH then only ON_CHECKOUT is allowed for return_when.

Possible values are:

  • ON_CHECKOUT

  • WITHIN_7_DAYS

  • WITHIN_14_DAYS

standard_phrases array of objects (Optional)

Contains settings related to standard phrases. You can send 1 or multiple standard phrases that you want to enable or remove.

name enum (Required)

Specifies the name of the standard phrase.

Supported standard_phrases_name types:

  • GuestIdentification

  • InformArrivalTime

  • PayBeforeStay

  • AccommodationTax

  • TattooRestriction

  • RequireInvoice

  • EarlyDeparture

  • PedestrianZoneOnly

  • LimitedParking

  • AccessByUnpavedRoad

  • OnsiteFunctions

  • NoHenStagParty

  • ResidentialArea

  • BusyArea

  • HalfBoardNoDrinks

  • NoPublicTransport

  • WaterCrisis

  • RussiaAntiHostelRegulations

  • LongStayDisclaimerJapan

  • GuestRentalAgreement

  • GuestUnder18

  • Covid19RestrictionOfGuests

  • Covid19ExtraCleaning

  • Covid19ReducedFoodServices

  • Covid19OnlyEssentialTravellers

  • Covid19ShuttleSuspended

  • Covid19ReducedServices

  • Covid19ReducedHoursOfService

  • Covid19ExtraDocumentation

  • Covid19ReducedFacilities

  • Covid19PhysicalDistance

  • Covid19LocalGuidelinesFollowed

  • Covid19FaceMaskMandatory

  • Covid19QuarantineNotAllowed

  • Covid19NoChargePCRTest

  • Covid19NoCostExtension

  • Covid19MedicalMonitoring

  • Covid19NegativeRequired

  • Covid19AtChargePCRTest

  • Covid19InsurancePCRTest

  • Covid19VaccinationNegativeTestCheckIn

  • Covid19VaccinationNegativeTestRecoveryCheckIn

  • Covid19VaccinationRecoveryCheckIn

  • Covid19NegativeTestRecoveryCheckIn

  • Covid19VaccinationCheckIn

  • Covid19RecoveryCheckIn

  • Covid19ProofRequired

  • IsraeliCitizensVat

  • Covid19BodyTempCheck

  • Covid19NoSelfQuarantine

enabled boolean (Required)

Specifies if standard phrase should be enabled or removed.

quiet_hours object (Optional)

Contains settings related to quiet hours of the property.

enabled boolean (Required)

Specifies whether the property has quiet hours enabled.

start string (Optional)

Specifies the quiet hours start time.

Required if enabled=true

Accepts the format: HH:mm

end string (Optional)

Specifies the quiet hours end time.

Required if enabled=true

Accepts the format: HH:mm

renovation object (Optional)

Contains settings related to renovation dates.

enabled boolean (Required)

Specifies whether renovation dates are enabled.

start string (Optional)

Specifies the renovation start date.

Required if enabled=true

Accepts the format: yyyy-mm-dd

end string (Optional)

Specifies the renovation end date.

Required if enabled=true

Accepts the format: yyyy-mm-dd

bed_linen_policy object (Optional)

Contains renting details for bed linens and towels as they are not included in the room rate. Guests can rent them at the property for an additional charge or bring their own.

enabled boolean (Required)

Specifies whether the option to rent bed linen is enabled.

amount double (Optional)

Specifies the cost of renting bed linens and towels specified in the property's default currency.

Required if enabled=true

accepted_payment_types object (Optional)

Contains settings related to payment methods.

codes array of integers (Required)

Specifies the list of supported payment methods. For a full list of payment codes, see Booking.com Payment Type Codes.

french_tax_details object (Optional)

Contains settings related to tax details. Required for specified countries.

Required to setup for properties located in the specified countries in order to go Open/Bookable.

category_idstring (Optional)

Contains a number - city tax category ID.

nature_id string (Optional)

Contains a number - nature category ID.

declare_revenue boolean (Required)

Specifies whether the property declares revenues as professional for direct tax purposes.

has_vatboolean (Required)

Specifies whether the property has a registered VAT for this activity.

registered_in_rcs boolean (Required)

Specifies whether the property is registered as a professional at the trade commercial register.

cancellation_exceptions object (Optional)

Contains settings related to cancellation for non-refundable policy.

grace_period object (Optional)

enabled boolean (Optional)

Specifies whether the property has a grace period enabled.

after_booking enum (Required)

Amount of hours after booking when free cancellation is available.

Possible values are:

  • HOUR_1

  • HOURS_4

  • HOURS_24

advance_cancellation object (Optional)

enabled boolean (Optional)

Specifies whether the property has an advance cancellation enabled.

before_check_in enum (Required)

Advance cancellation - amount of weeks before check-in when free cancellation is available.

Possible values are:

  • WEEKS_4

  • WEEKS_8

  • WEEKS_12

age_buckets array of objects (Optional)

Contains age bucket details.

No age bucket set up by default.

You can create up to three age buckets per property.

Each age bucket contains a minimum and maximum age, where the maximum age is inclusive.

Age buckets can't overlap with each other.

min_age integer (Required)

Specifies the minimum age for the age bucket.

max_age integer (Required)

Specifies the maximum age for the age bucket.

children_policies object (Optional)

Indicates whether a property accepts children.

allow_children boolean (Optional)

Specifies whether the property admits adults and children, or only adults.

min_age integer (Optional)

Specifies the minimum age of children allowed to stay at the property.

Applies only when allow_children = true

policy_rules array of objects (Optional)

You can specify different price and rules for children.

Applies only when allow_children = true

Rules ages cannot be overlapped with other rules that have the same type.

rule_type enum (Required)

Specifies the rule type for which this rule applies.

Possible values are:

  • EXISTING_BED

  • EXTRA_BED

  • CRIB

  • EXTRA_BED_FOR_ADULT

from_age integer (Required)

Specifies the minimum age for the children policy to apply.

to_age integer (Required)

Specifies the maximum age for the children policy to apply.

price_type enum (Required)

Specifies if the rule is FREE or has a FIXED price.

Possible values are:

  • FREE

  • FIXED

  • ADULT_PERCENTAGE

price_mode enum (Required)

Specifies the unit of time on which the charge is calculated.

Possible values are:

  • PER_NIGHT

  • PER_STAY

price double (Optional)

Specifies the amount charged in the country's local currency.

Required if price_type=FIXED

booking_model object (Optional)

Indicates that property can have request to book option.

type enum (Required)

Specifies the booking model type of the property.

Default:IB.

Possible values: RTB and IB.

invoice_settings object (Optional)

Details of the company that owns/manages the property.

Invoice settings cannot be updated during the billing period from 1st to 7th day of the month.

legal_name string (Optional)

Legal name of the company.

country_code string (Optional)

Country Code. Should be valid ISO code.

You need to setup if you want property to go Open/Bookable.

city string (Optional)

City name.

You need to setup if you want property to go Open/Bookable.

postal_code string (Optional)

Postal/Zip code.

You need to setup if you want property to go Open/Bookable and should have valid postal/zip code for the country code.

state string (Optional)

State name.

notification_channel enum (Optional)

The channel how company should be notified invoice related mails.

Possible values are:

  • POSTAL_MAIL

  • EMAIL

contact_person string (Optional)

Full name of the contact person.

You need to setup if you want property to go Open/Bookable.

address string (Optional)

Company address.

You need to setup if you want property to go Open/Bookable.

brazil_tax_details object (Optional)

Indicates additional settings for Brazilian properties.

You need to setup brazil tax details if you want property in Brazil to go Open/Bookable.

tax_payer_number_type string (Optional)

Specifies whether the identifying number belongs to a company or a private individual.

tax_payer_number string (Optional)

The identifying number. CNPJ = 14 digits. CPF = 11 digits.

city_hall_id string (Optional)

The 8-digit ID for the city hall which issued the CNPJ or CPF number.

email string (Optional)

Email address of invoice recipient.

Sample Request

{
   "hotel_id": "AWSTEST",
   "channel_hotel_id": "12837615",
   "property_settings": {
       "require_cvc": true,
       "view_cc_details": true,
       "curfew": {
           "enabled": true,
           "start": "18:00",
           "end": "09:00"
       },
       "require_booker_address": true,
       "require_booker_phone_number": true,
       "age_restriction": {
           "enabled": true,
           "min": 18,
           "max": 99
       },
       "auto_replenish": true,
       "replenish_closed_rooms": true,
       "long_stay": {
           "enabled": true,
           "max_length_of_stay": 45
       },
       "pricing_type": "Standard",
       "allow_smoking": true
   },
   "pets": {
       "pets_allowed": "PETS_NOT_ALLOWED",
       "pets_price_type": "FREE"
   },
   "damage_policy": {
       "amount": 90,
       "currency": "INR",
       "policy_type": "HANDLED_BY_PROPERTY",
       "damage_programme_terms_agreed": true,
       "collection_mode": "CASH",
       "collection_when": "ON_ARRIVAL",
       "return_mode": "CASH",
       "return_when": "ON_CHECKOUT"
   },
   "standard_phrases": [
       {
           "name": "GuestIdentification",
           "enabled": true
       }
   ],
   "quiet_hours": {
       "enabled": true,
       "start": "18:00",
       "end": "08:30"
   },
   "renovation": {
       "enabled": true,
       "start": "2014-01-01",
       "end": "2014-01-10"
   },
   "bed_linen_policy": {
       "enabled": false,
       "amount": 100
   },
   "accepted_payment_types": {
       "codes": [
           1,
           2,
           55
       ]
   },
   "french_tax_details": {
       "category_id": "11",
       "nature_id": "1",
       "declare_revenue": true,
       "has_vat": true,
       "registered_in_rcs": true
   },
   "cancellation_exceptions": {
       "grace_period": {
           "enabled": true,
           "after_booking": "HOURS_4"
       },
       "advance_cancellation": {
           "enabled": true,
           "before_check_in": "WEEKS_4"
       }
   },
   "age_buckets": [
       {
           "min_age": 1,
           "max_age": 10
       }
   ],
   "children_policies": {
       "allow_children": true,
       "min_age": 0,
       "policy_rules": [
           {
               "rule_type": "EXISTING_BED",
               "from_age": 0,
               "to_age": 10,
               "price_type": "FIXED",
               "price_mode": "PER_STAY",
               "price": 0
           }
       ]
   },
   "booking_model": {
       "type": "IB"
   },
   "invoice_settings": {
       "legal_name": "string",
       "contact_person": "string",
       "address": "string",
       "country_code": "US",
       "city": "san francisco",
       "postal_code": "395001",
       "state": "st",
       "notification_channel": "POSTAL_MAIL",
       "brazil_tax_details": {
           "tax_payer_number_type": "CNPJ",
           "tax_payer_number": "11",
           "city_hall_id": "12345678",
           "email": "vishal@gmail.com"
       }
   }
}

Sample Examples for Setting up Policies

1. Age Restriction Policy

{
   "hotel_id": "AWSTEST",
   "channel_hotel_id": "12837615",
   "property_settings": {
       "age_restriction": {
           "enabled": true,
           "min": 18,
           "max": 99
       }
   }
}

2. Auto Replenish Policy

{
   "hotel_id": "AWSTEST",
   "channel_hotel_id": "12837615",
   "property_settings": {
       "auto_replenish": true,
       "replenish_closed_rooms": true
   }
}

3. Pets Policy

{
   "hotel_id": "AWSTEST",
   "channel_hotel_id": "12837615",
   "pets": {
       "pets_allowed": "PETS_NOT_ALLOWED",
       "pets_price_type": "FREE"
   }
}

4. Damage Policy

{
   "hotel_id": "AWSTEST",
   "channel_hotel_id": "12837615",
   "damage_policy": {
       "amount": 90,
       "currency": "INR",
       "policy_type": "HANDLED_BY_PROPERTY",
       "damage_programme_terms_agreed": true,
       "collection_mode": "CASH",
       "collection_when": "ON_ARRIVAL",
       "return_mode": "CASH",
       "return_when": "ON_CHECKOUT"
   }
}

5. Standard Phrases

{
   "hotel_id": "AWSTEST",
   "channel_hotel_id": "12837615",
   "standard_phrases": [
       {
           "name": "GuestIdentification",
           "enabled": true
       }
   ]
}

6. Quiet Hours Policy

{
   "hotel_id": "AWSTEST",
   "channel_hotel_id": "12837615",
   "quiet_hours": {
       "enabled": true,
       "start": "18:00",
       "end": "08:30"
   }
}

7. Renovation Policy

{
   "hotel_id": "AWSTEST",
   "channel_hotel_id": "12837615",
   "renovation": {
       "enabled": true,
       "start": "2014-01-01",
       "end": "2014-01-10"
   }
}

8. Bed Linen Policy

{
   "hotel_id": "AWSTEST",
   "channel_hotel_id": "12837615",
   "bed_linen_policy": {
       "enabled": false,
       "amount": 100
   }
}

9. Accepted Payment Types Policy

{
   "hotel_id": "AWSTEST",
   "channel_hotel_id": "12837615",
   "accepted_payment_types": {
       "codes": [1, 2, 55]
   }
}

10. French Tax Details Policy

{
   "hotel_id": "AWSTEST",
   "channel_hotel_id": "12837615",
   "french_tax_details": {
       "category_id": "11",
       "nature_id": "1",
       "declare_revenue": true,
       "has_vat": true,
       "registered_in_rcs": true
   }
}

11. Cancellation Exceptions Policy

{
   "hotel_id": "AWSTEST",
   "channel_hotel_id": "12837615",
   "cancellation_exceptions": {
       "grace_period": {
           "enabled": true,
           "after_booking": "HOURS_4"
       },
       "advance_cancellation": {
           "enabled": true,
           "before_check_in": "WEEKS_4"
       }
   }
}

12. Age Buckets Policy

{
   "hotel_id": "AWSTEST",
   "channel_hotel_id": "12837615",
   "age_buckets": [
       {
           "min_age": 1,
           "max_age": 10
       }
   ]
}

13. Children Policies

{
   "hotel_id": "AWSTEST",
   "channel_hotel_id": "12837615",
   "children_policies": {
       "allow_children": true,
       "min_age": 0,
       "policy_rules": [
           {
               "rule_type": "EXISTING_BED",
               "from_age": 0,
               "to_age": 10,
               "price_type": "FIXED",
               "price_mode": "PER_STAY",
               "price": 0
           }
       ]
   }
}

14. Booking Model Policy

{
   "hotel_id": "AWSTEST",
   "channel_hotel_id": "12837615",
   "booking_model": {
       "type": "IB"
   }
}

15. Invoice Settings

{
   "hotel_id": "AWSTEST",
   "channel_hotel_id": "12837615",
   "invoice_settings": {
       "legal_name": "string",
       "contact_person": "string",
       "address": "string",
       "country_code": "US",
       "city": "san francisco",
       "postal_code": "395001",
       "state": "st",
       "notification_channel": "POSTAL_MAIL",
       "brazil_tax_details": {
           "tax_payer_number_type": "CNPJ",
           "tax_payer_number": "11",
           "city_hall_id": "12345678",
           "email": "vishal@gmail.com"
       }
   }
}

Response

Sample Success Response

{
  "Status": "Success",
  "Message": "Successfully done",
  "Warnings": "",
  "Ruid": "e527c45a-f23a-4ee4-beb2-7d21f7699b1b",
  "data": {
    "property_settings": {
      "success": true
    },
    "renovation": {
      "success": true
    },
    "standard_phrases": {
      "success": true
    },
    "bed_linen_policy": {
      "success": true
    },
    "child_policies": {
      "success": true
    },
    "age_buckets": {
      "success": true
    },
    "quiet_hours": {
      "success": true
    },
    "booking_model": {
      "success": true
    },
    "cancellation_exceptions": {
      "success": true
    },
    "french_tax_details": {
      "success": true
    },
    "damage_policy": {
      "success": true
    }
  }
}

Success Response Body Elements

Status string

Indicates the overall status of the request. In this case, "Success" means the operation was completed successfully.

Message string

Provides a brief message about the outcome. Here, it states "Successfully done," confirming that the request was processed without issues.

data object

Contains detailed results of the various settings processed in the request.

property_settings object

Indicates whether the property settings were successfully updated. Here, it is true.

renovation object

Indicates whether the renovation settings were successfully updated. Here, it is true.

standard_phrases object

Indicates whether the standard phrases were successfully updated. Here, it is true.

bed_linen_policy object

Indicates whether the bed linen policy was successfully updated. Here, it is true.

child_policies object

Indicates whether the child policies were successfully updated. Here, it is true.

age_buckets object

Indicates whether the age buckets were successfully updated. Here, it is true.

quiet_hours object

Indicates whether the quiet hours settings were successfully updated. Here, it is true.

booking_model object

Indicates whether the booking model settings were successfully updated. Here, it is true.

cancellation_exceptions object

Indicates whether the cancellation exceptions were successfully updated. Here, it is true.

french_tax_details object

Indicates whether the French tax details were successfully updated. Here, it is true.

damage_policy object

Indicates whether the damage policy settings were successfully updated. Here, it is true.

Indicates the result of the API call.

Errors

Sample Error Response 1

{
   "Errors": [
       {
           "Code": "400",
           "ShortText": "HotelCode: Invalid HotelCode ('AWSTEST')"
       }
   ],
   "Status": "Fail"
}

Sample Error Response 2

{
   "Errors": [
       {
           "Code": "573",
           "ShortText": "channel-mapping not found for this property!"
       }
   ],
   "Status": "Fail"
}

Sample Error Response 3

{
   "Errors": [
       {
           "Code": "611",
           "ShortText": "property_settings - require_cvc is invalid or not found!"
       }
   ],
   "Status": "Fail"
}

Sample Error Response 4

{
   "Status": "Fail",
   "Errors": [],
   "Message": "Invalid value: Curfew settings overlap with check-in/check-out",
   "Ruid": "909864b8-5509-4a4e-98d2-6a52dfef7466",
   "Data": {}
}

Error Response Body Elements

Status string

Indicates the result of the API call, which will be always "Fail" in case of an error response.

Error array

Array that contains details about any errors that occurred during the API call. Each object in the Errors array contains the following properties:

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

A message providing more information about the error.

PreviousRetrieve City Tax Category For Property SettingsNextCreate / Update Property Settings - Specific Setting

Last updated

Was this helpful?