Set Unit
This endpoint assigns or updates unit details, including area, facilities, and spaces (bedrooms, bathrooms, living rooms, and offices) for a specific property listing on VRBO.
Endpoint
POST
https://connect-sandbox.su-api.com/SUAPI/jservice/vrbo/unit/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 integer (Required)
VRBO listing ID from which units are to be set.
area object (Optional)
Specifies the total area of the unit.
unit string (Optional)
Measurement unit for the area (for example, "SQUARE_METERS", "SQUARE_FEET").
value integer (Optional)
Numerical value representing the area size.
facilities array (Optional)
List of facilities available in the unit.
room_facility_id integer (Optional)
Unique identifier of the room facility.
room_facility_name string (Optional)
Name or description of the room facility (for example, pool, private pool).
instances array (Optional)
Key-value pairs describing each facility instance.
key string (Optional)
Attribute key for the facility.
value string (Optional)
Corresponding value for the facility key.
spaces object (Optional)
Defines different types of spaces within the unit.
dining_rooms object (Optional)
Specifies the dining room capacity.
capacity integer (Optional)
Maximum capacity of the dining area.
bed_rooms array (Optional)
List of bedrooms in the unit.
id string (Optional)
Unique ID of the bedroom.
text array (Optional)
Localized metadata for the bedroom (for example, name, notes).
key string (Optional)
Field type such as "space-name" or "space-notes".
values array (Optional)
List of localized text values.
locale string (Optional)
Locale code (for example, "en-US", "fr-FR").
value string (Optional)
Localized string for that field.
bed_groups object (Optional)
Contains information about beds in the bedroom.
beds array (Optional)
List of bed configurations.
type string (Optional)
Type of bed (for example, "KingBed", "QueenBed", "SofaBed").
size string (Optional)
Size of the bed (for example, "King", "Full", "Twin").
quantity integer (Optional)
Number of beds of this type.
living_rooms array (Optional)
Structure defining living room.
id string (Optional)
Unique living room ID.
text array (Optional)
Localized data (same format as bedrooms).
bed_groups object (Optional)
Bed setup for the living room.
facilities array (Optional)
List of facilities available in the bathroom (for example, bathtub, shower).
bathroom_facility_id integer (Optional)
Unique ID of the bathroom.
bathroom_facility_name string (Optional)
Name of the bathroom.
instances array (Optional)
Optional detailed key-value pairs describing each facility.
offices array (Optional)
Structure defining offices.
bath_rooms array (Optional)
Structure defining bath rooms.
id string (Optional)
Unique bathroom ID.
type string (Optional)
Bathroom type (for example, "FULL_BATH", "HALF_BATH").
text array (Optional)
Localized text for bathroom details.
facilities array (Optional)
List of facilities available in the bathroom.
bathroom_facility_id integer (Optional)
Facility ID.
bathroom_facility_name string (Optional)
Facility name (for example, "bathtub", "outdoor shower").
instances array (Optional)
Additional facility-level metadata (key-value pairs).
Request
{
"hotel_id": "AWSTEST",
"listing_id": "73845690",
"area": {
"unit": "SQUARE_METERS",
"value": 250
},
"facilities": [
{
"room_facility_id": 232,
"room_facility_name": "pool",
"instances": [
{
"key": "shared",
"value": "TRUE"
},
{
"key": "shared-description",
"value": "ONSITE11111111111111"
}
]
},
{
"room_facility_id": 93,
"room_facility_name": "private pool",
"instances": [
{
"value": "ONSITE",
"key": "description"
}
]
}
],
"spaces": {
"dining_rooms": {
"capacity": 6
},
"bed_rooms": [
{
"id": "1169475c-6d61-4f5f-bb5c-0d144885185d",
"text": [
{
"key": "space-name",
"values": [
{
"locale": "fr-FR",
"value": "Bedroom OK1 FRRRR"
}
]
},
{
"key": "space-notes",
"values": [
{
"locale": "ja-JP",
"value": "Bedroom OK22 en-US"
}
]
}
],
"bed_groups": {
"beds": [
{
"type": "KingBed",
"size": "King",
"quantity": 2
},
{
"type": "QueenBed",
"size": "Queen",
"quantity": 1
}
]
}
}
],
"living_rooms": [
{
"id": "835ee349-740a-4702-9ef0-394ddc4be0fb",
"text": [
{
"key": "space-name",
"values": [
{
"value": "Pushap 1",
"locale": "en-US"
}
]
}
],
"bed_groups": {
"beds": [
{
"type": "SofaBed",
"size": "Full",
"quantity": 1
}
]
}
},
{
"id": "17fc09e4-e162-4f79-a676-d3adf8dc5714",
"text": [
{
"key": "space-name",
"values": [
{
"value": "Ronak 1 living 1",
"locale": "en-US"
}
]
}
],
"bed_groups": {
"beds": [
{
"type": "MurphyBed",
"size": "Full",
"quantity": 2
}
]
}
},
{
"id": "8db268d5-9109-492c-b60c-8fe2898baf1b",
"text": [
{
"key": "space-name",
"values": [
{
"value": "Murphy 1 living",
"locale": "en-US"
}
]
}
],
"bed_groups": {
"beds": [
{
"type": "MurphyBed",
"size": "Full",
"quantity": 1
}
]
}
}
],
"offices": [
{
"id": "97dd2dfb-b9e2-4120-a613-492ab72da34f",
"text": [
{
"key": "space-name",
"values": [
{
"value": "Living officename 1",
"locale": "en-US"
}
]
}
],
"bed_groups": {
"beds": [
{
"type": "SofaBed",
"size": "Full",
"quantity": 1
}
]
}
},
{
"id": "ca9d52d5-b418-4b28-8fca-8a15bb603d51",
"text": [
{
"key": "space-name",
"values": [
{
"locale": "en-US",
"value": "Living officename 2"
},
{
"locale": "fr-FR",
"value": "Living officename 2 fr-FR"
}
]
}
],
"bed_groups": {
"beds": [
{
"type": "Futon",
"size": "Twin",
"quantity": 1
}
]
}
}
],
"bath_rooms": [
{
"id": "3cd0b93e-2973-424c-8f8a-bebf0228430a",
"type": "FULL_BATH",
"text": [
{
"key": "space-name",
"values": [
{
"locale": "en-US",
"value": "Bedroom bathrooms"
}
]
},
{
"key": "space-notes",
"values": [
{
"value": "Bedroom bathrooms bathrooms",
"locale": "en-US"
}
]
}
],
"facilities": [
{
"bathroom_facility_id": 4,
"bathroom_facility_name": "bathtub shower",
"instances": [
{
"key": "type",
"value": "BATHTUB_OR_SHOWER"
}
]
},
{
"bathroom_facility_id": 5,
"bathroom_facility_name": "outdoor shower",
"instances": []
}
]
},
{
"id": "11325a96-5039-4e63-8525-29838ce835f8",
"type": "FULL_BATH",
"text": [
{
"key": "space-name",
"values": [
{
"locale": "en-US",
"value": "Bedroom bathrooms bathrooms bathrooms"
}
]
},
{
"key": "space-notes",
"values": [
{
"value": "Bedroom 23232",
"locale": "en-US"
}
]
}
],
"facilities": [
{
"bathroom_facility_id": 4,
"bathroom_facility_name": "bathtub shower",
"instances": []
}
]
}
]
}
}Response
Success Response
{
"Status": "Success",
"Data": [],
"Message": "Unit 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?