Set Policy
This endpoint configures or updates the booking, stay, check-in/out, events, pets, smoking, and custom policies for a VRBO property listing.
Endpoint
POST
https://connect-sandbox.su-api.com/SUAPI/jservice/vrbo/policy/setHeader
app-id: YOUR_APP_ID
Authorization: YOUR_API_KEY
Content-Type: application/jsonapp-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
hotel_id string (Required)
The unique property ID as assigned by the provider upon creation of the property.
listing_id string (Required)
VRBO listing ID.
booking_policy object (Required)
Contains rules related to booking for the property.
booking_type string (Required)
Type of booking allowed.
accepted_payment_forms object (Required)
Payment methods accepted for bookings.
payment_card_descriptors array (Optional)
List of accepted credit/debit cards.
code string (Required)
Code for the card type.
type string (Required)
Type of the card.
payment_invoice_descriptors array (Optional)
List of accepted invoice payment types.
type string (Required)
Type of invoice payment.
stay_policy object (Required)
Contains policies related to the stay of guests.
rental_agreement_url string (Optional)
URL to the rental agreement PDF document.
max_occupancy_policy object (Optional)
Rules related to maximum occupancy.
adult_count integer (Required)
Maximum number of adults allowed.
total_guest_count integer (Required)
Maximum number of total guests allowed.
note object (Optional)
Additional notes regarding max occupancy.
locale string (Optional)
Locale of the note.
description string (Optional)
Text describing max occupancy rules.
children_policy object (Optional)
Rules related to children staying at the property.
allowed boolean (Required)
Whether children are allowed.
allowed_ages array (Optional)
Age ranges of children allowed.
ageRange string (Required)
Age range.
children_allowed_note object (Optional)
Note when children are allowed.
locale string (Optional)
Locale of the note.
description string (Optional)
Text describing allowed children rules.
children_not_allowed_note object (Optional)
Note when children are not allowed.
locale string (Optional)
Locale of the note.
description string (Optional)
Text describing children not allowed rules.
check_in_policy object (Optional)
Rules regarding check-in.
check_in_periods object (Optional)
Time window for check-in.
start object (Optional)
Start of check-in period.
exact_time string (Optional)
Exact start time.
approximate_time string (Optional)
Approximate start time.
min_age object (Optional)
Minimum age allowed for check-in.
value integer (Required)
Minimum age value.
note object (Optional)
Additional note regarding age limit.
locale string (Optional)
Locale of the note.
description string (Optional)
Description of age restriction.
check_out_policy object (Optional)
Rules regarding check-out.
check_out_time object (Optional)
Check-out time information.
exact_time string (Optional)
Exact check-out time.
approximate_time string (Optional)
Approximate check-out time.
events_policy object (Optional)
Rules for events held at the property.
allowed boolean (Required)
Whether events are allowed.
allowed_events object (Optional)
Details about allowed events.
max_attendees integer (Optional)
Maximum attendees allowed.
types array (Optional)
Types of events allowed.
note object (Optional)
Additional notes for events.
locale string (Optional)
Locale of the note.
description string (Optional)
Text describing events policy.
pets_policy object (Optional)
Rules regarding pets at the property.
allowed boolean (Required)
Whether pets are allowed.
allowed_pets object (Optional)
Details about allowed pets.
types array (Optional)
Types of pets allowed.
max_allowed integer (Optional)
Maximum number of pets allowed.
max_weight object (Optional)
Maximum weight allowed per pet.
amount integer (Optional)
Amount of max weight.
weight_unit string (Optional)
Unit of weight.
note object (Optional)
Notes related to pets.
locale string (Optional)
Locale of the note. Example: "en-US".
description string (Optional)
Description of pets policy.
smoking_policy object (Optional)
Rules regarding smoking.
allowed boolean (Required)
Whether smoking is allowed.
note object (Optional)
Additional note about smoking.
locale string (Optional)
Locale of note.
description string (Optional)
Text describing smoking policy.
indoor_policy object (Optional)
Rules regarding indoor smoking.
allowed boolean (Required)
Whether indoor smoking is allowed.
allowed_note object (Optional)
Additional note for indoor smoking.
locale string (Optional)
Locale of note.
description string (Optional)
Text describing indoor policy.
outdoor_policy object (Optional)
Rules regarding outdoor policy.
allowed boolean (Required)
Whether outdoor smoking is allowed.
allowed_note object (Optional)
Additional note.
locale string (Optional)
Locale of note.
description string (Optional)
Text describing outdoor smoking policy.
custom_policies array (Optional)
Custom rules defined by the property owner.
description object (Optional)
Description of the custom rule.
locale string (Optional)
Locale of the description.
description string (Optional)
Text describing the custom rule.
Request
{
"hotel_id": "AWSTEST",
"listing_id": "73845690",
"booking_policy": {
"booking_type": "INSTANT",
"accepted_payment_forms": {
"payment_card_descriptors": [
{
"code": "MASTERCARD",
"type": "CREDIT"
},
{
"code": "VISA",
"type": "CREDIT"
}
],
"payment_invoice_descriptors": [
{
"type": "BANKTRANSFER"
}
]
}
},
"stay_policy": {
"rental_agreement_url": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf",
"max_occupancy_policy": {
"adult_count": "5",
"total_guest_count": "6",
"note": {
"locale": "en-US",
"description": "The above events are allowed and max number"
}
},
"children_policy": {
"allowed": "false",
"allowed_ages": [
{
"ageRange": "0-2"
},
{
"ageRange": "3-12"
},
{
"ageRange": "13-17"
}
],
"children_allowed_note": {
"locale": "en-US",
"description": "child allowed description"
},
"children_not_allowed_note": {
"locale": "en-US",
"description": "child not allowed description"
}
},
"check_in_policy": {
"check_in_periods": {
"start": {
"approximate_time": "FLEXIBLE",
"exact_time": "01:00"
}
},
"min_age": {
"value": "13",
"note": {
"locale": "en-US",
"description": "The Age Limit is 12"
}
}
},
"check_out_policy": {
"check_out_time": {
"approximate_time": "FLEXIBLE",
"exact_time": "12:00"
}
},
"events_policy": {
"allowed": "true",
"allowed_events": {
"max_attendees": "99",
"types": [
"WEDDINGS",
"FAMILY_GATHERING",
"BIRTHDAY_PARTIES",
"OTHER_EVENTS"
]
},
"note": {
"locale": "en-US",
"description": "The above events are allowed and max number"
}
},
"pets_policy": {
"allowed": "true",
"allowed_pets": {
"types": [
"CATS",
"DOGS"
],
"max_allowed": "9",
"max_weight": {
"amount": "99",
"weight_unit": "KILOGRAMS"
}
},
"note": {
"locale": "en-US",
"description": "Pets of any type are allowed"
}
},
"smoking_policy": {
"allowed": "true",
"note": {
"locale": "en-US",
"description": "ok Smoking is allowed and you can choose."
},
"indoor_policy": {
"allowed": "true",
"allowed_note": {
"locale": "en-US",
"description": "indoor smoking allowed in room."
}
},
"outdoor_policy": {
"allowed": "true",
"allowed_note": {
"locale": "en-US",
"description": "outdoor smoking allowed out of property"
}
}
},
"custom_policies": [
{
"description": {
"locale": "en-AU",
"description": "New custom house rule 1"
}
},
{
"description": {
"locale": "en-AU",
"description": "New custom house rule 2"
}
}
]
}
}Response
Success Response
{
"Status": "Success",
"Data": [],
"Message": "Policy set successfully",
"Trace-ID": ""
}Success Response - Body Elements
Status string
Indicates the result of the API call.
Data object
The response data, the root element.
Message string
The message in the response.
Trace-ID string
Unique ID for tracing the API request.
Error Response
{
"Status": "Fail",
"Errors": [
{
"Code": "400",
"ShortText": "hotel_id: Invalid HotelCode (:hotelid)"
},
{
"Code": "2004",
"ShortText": "Listing Id is required"
}
],
"Message": "",
"Trace-ID": ""
}Error Response - Body Elements
Status string
Indicates the result of the API call.
Errors array
The response error, the root element.
Code string
Specific error code that helps identify the type of error.
ShortText string
A short description of the error.
Message string
The message in the response.
Trace-ID string
Unique ID for tracing the API request.
Last updated
Was this helpful?