{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/properties/:uid","auth":"required","params":[{"name":"uid","type":"string","default":"","desc":"The unique id of the property","required":true,"in":"path","ref":"","_id":"56e795d715f96b2200878e48"},{"name":"type","type":"string","default":"","desc":"Can be HOUSE,  COTTAGE,  CONDO,  BEDANDBREAKFAST,         VILLA,      CHALET, CABIN, STUDIO, ROOM, APARTMENT, OTHER","required":false,"in":"body","ref":"","_id":"56e795d715f96b2200878e47"},{"name":"name","type":"string","default":"","desc":"The name of the property","required":false,"in":"body","ref":"","_id":"56e795d715f96b2200878e46"},{"name":"baseGuests","type":"int","default":"","desc":"The base number of guests","required":false,"in":"body","ref":"","_id":"56e795d715f96b2200878e45"},{"name":"maximumGuests","type":"int","default":"","desc":"The maximum number of guests","required":false,"in":"body","ref":"","_id":"56e795d715f96b2200878e44"},{"name":"baseDailyRate","type":"double","default":"","desc":"The daily base rate","required":false,"in":"body","ref":"","_id":"56e795d715f96b2200878e43"},{"name":"city","type":"string","default":"","desc":"The city in which this property is located","required":false,"in":"body","ref":"","_id":"56e795d715f96b2200878e42"},{"name":"state","type":"string","default":"","desc":"The state in which this property is located","required":false,"in":"body","ref":"","_id":"56e795d715f96b2200878e41"},{"name":"address1","type":"string","default":"","desc":"The addres of this property","required":false,"in":"body","ref":"","_id":"56e795d715f96b2200878e40"},{"name":"address2","type":"string","default":"","desc":"The addres  (line 2) of this property","required":false,"in":"body","ref":"","_id":"56e795d715f96b2200878e3f"},{"name":"postalCode","type":"string","default":"","desc":"The postal code of this property","required":false,"in":"body","ref":"","_id":"56e795d715f96b2200878e3e"},{"name":"countryCode","type":"string","default":"","desc":"Use an ISO_3166-1_alpha-2 format","required":false,"in":"body","ref":"","_id":"56e795d715f96b2200878e3d"},{"name":"bedrooms","type":"int","default":"","desc":"The number of bedrooms in this property","required":false,"in":"body","ref":"","_id":"56e795d715f96b2200878e3c"},{"name":"bathrooms","type":"string","default":"","desc":"The number of bathrooms in this property","required":false,"in":"body","ref":"","_id":"56e795d715f96b2200878e3b"},{"name":"picture","type":"string","default":"","desc":"The picture URL of this property. Note that this URL will be overridden by the picture uploaded via the interface","required":false,"in":"body","ref":"","_id":"56e795d715f96b2200878e3a"},{"name":"webLink","type":"string","default":"","desc":"A web link representing this property","required":false,"in":"body","ref":"","_id":"56e795d715f96b2200878e39"},{"name":"cleaningFeeAmount","type":"double","default":"","desc":"The amount of the cleaning fee","required":false,"in":"body","ref":"","_id":"56e795d715f96b2200878e38"},{"name":"minimumStay","type":"int","default":"","desc":"The minimum number of days for a stay","required":false,"in":"body","ref":"","_id":"56e795d715f96b2200878e37"},{"name":"maximumStay","type":"int","default":"0","desc":"The maximum stay  number of days for a stay. Set to 0 for unlimited maximum stay","required":false,"in":"body","ref":"","_id":"59a4413e9749ce001bf3353a"},{"name":"securityDepositAmount","type":"double","default":"","desc":"The amount of the security deposit","required":false,"in":"body","ref":"","_id":"56e795d715f96b2200878e36"},{"name":"externalID","type":"string","default":"","desc":"A reference ID for this property in your own system","required":false,"in":"body","ref":"","_id":"56e795d715f96b2200878e35"},{"name":"acceptInstantBook","type":"boolean","default":"","desc":"Whether this property accepts instant booking","required":false,"in":"body","ref":"","_id":"56e795d715f96b2200878e34"},{"name":"isActive","type":"boolean","default":"","desc":"Whether this property is active","required":false,"in":"body","ref":"","_id":"56f1abc14476fb2200795e68"},{"name":"description","type":"string","default":"","desc":"Description of this property","required":false,"in":"body","ref":"","_id":"56f1abc14476fb2200795e67"},{"name":"floor","type":"int","default":"","desc":"The floor of this property","required":false,"in":"body","ref":"","_id":"56f45a12b6a1522900aedef5"},{"name":"areaSize","type":"int","default":"","desc":"The area size of this property","required":false,"in":"body","ref":"","_id":"56f45a12b6a1522900aedef4"},{"name":"areaSizeUnit","type":"string","default":"","desc":"Can be SQUARE_METERS or SQUARE_FEET","required":false,"in":"body","ref":"","_id":"56f45a12b6a1522900aedef3"},{"name":"extraGuestFee","type":"double","default":"","desc":"The extra guest fee of this property","required":false,"in":"body","ref":"","_id":"56f476deab3f610e000a6474"},{"name":"taxationRate","type":"double","default":"","desc":"The taxation rate of this property in percentage","required":false,"in":"body","ref":"","_id":"56f47f296bd7a20e00d22b24"},{"name":"latitude","type":"double","default":"","desc":"The latitude of this property","required":false,"in":"body","ref":"","_id":"570d86a6d1e4b82000d9e3ac"},{"name":"longitude","type":"double","default":"","desc":"The longitude of this property","required":false,"in":"body","ref":"","_id":"570d86a6d1e4b82000d9e3ab"},{"name":"shortDescription","type":"string","default":"","desc":"Short description of this property","required":false,"in":"body","ref":"","_id":"583cfefc005871230068d9b7"},{"name":"panoramicDataUrl","type":"string","default":"","desc":"Panoramic URL","required":false,"in":"body","ref":"","_id":"583cfefc005871230068d9b6"},{"name":"cancellationPolicy","type":"string","default":"","desc":"The cancellation policy","required":false,"in":"body","ref":"","_id":"583cfefc005871230068d9b5"},{"name":"guideBookUrl","type":"string","default":"","desc":"Guide book URL","required":false,"in":"body","ref":"","_id":"5a9f7717e309c60012823e18"},{"name":"bookingWindow","type":"int","default":"-1","desc":"Number of days in the future for which bookings are accepted. -1 means anytime, then 90, 180, 365 or 547 days","required":false,"in":"body","ref":"","_id":"5bf3ac89fef3f5005c169b24"},{"name":"bookingWindowAfterCheckout","type":"int","default":"-1","desc":"How far from the current date can a guest make a booking after each checkout","required":false,"in":"body","ref":"","_id":"5bf3a000cb9c600013704cb9"},{"name":"weekEndRatePercentAdjustment","type":"double","default":"0","desc":"Provides a rate adjustment for week-ends, in percentage","required":false,"in":"body","ref":"","_id":"5bf3a000cb9c600013704cb8"},{"name":"turnOverDays","type":"int","default":"0","desc":"Number of days non-bookable between 2 bookings. 0, 1 or 2 days","required":false,"in":"body","ref":"","_id":"5bf3a000cb9c600013704cb7"},{"name":"bookingLeadTime","type":"int","default":"48","desc":"Number of hours needed before check-in for accepting a booking. 0 to 24, 48, 72 or 168 hours","required":false,"in":"body","ref":"","_id":"5bf3a000cb9c600013704cb6"},{"name":"defaultCheckinTime","type":"int","default":"15","desc":"The default checkin time for this property.","required":false,"in":"body","ref":"","_id":"5bf3a000cb9c600013704cb5"},{"name":"defaultCheckoutTime","type":"int","default":"11","desc":"The default checkout time for this property.","required":false,"in":"body","ref":"","_id":"5bf3a000cb9c600013704cb4"},{"name":"wifiNetwork","type":"string","default":"","desc":"The name of the Wifi network at this property","required":false,"in":"body","ref":"","_id":"5bf3a000cb9c600013704cb3"},{"name":"wifiPassword","type":"string","default":"","desc":"The Wifi password at this property","required":false,"in":"body","ref":"","_id":"5bf3a000cb9c600013704cb2"},{"name":"onlyCheckInOnDay","type":"int","default":"0","desc":"0 (No restriction) - 1 (Monday) - 2 (Tuesday) - 3 (Wednesday) - 4 (Thursday) - 5 (Friday) - 6 (Staturday) - 7 (Sunday)","required":false,"in":"body","ref":"","_id":"5bf3a000cb9c600013704cb1"},{"name":"currency","type":"string","default":"","desc":"currency of this property","required":false,"in":"body","ref":"","_id":"5c40032f2d3b1e004bd27476"},{"name":"rentalLicenseNumber","type":"string","default":"","desc":"Rental license number","required":false,"in":"body","ref":"","_id":"5c470609bff9bd0a4c4beffb"},{"name":"rentalLicenseNumberExpirationDate","type":"yyyy-mm-dd","default":"","desc":"Rental licence number expiration date","required":false,"in":"body","ref":"","_id":"5c470609bff9bd0a4c4beffa"},{"name":"minimumWeekendStay","type":"int","default":"","desc":"Minimum weekend stay","required":false,"in":"body","ref":"","_id":"5c470609bff9bd0a4c4beff9"},{"name":"rentalConditions","type":"string","default":"","desc":"Rental Conditions","required":false,"in":"body","ref":"","_id":"5d35c112575788006ff3b868"}],"results":{"codes":[{"status":200,"name":"","code":"{\n  \"uid\": \"4f6a3a32-6d57-450d-8b46-44abb3b01994\",\n  \"isActive\": true,\n\t\"description\": \"This Point Reyes House is located on a quiet rural lane, 2 mns from the village of Point Reyes Station, just one hour north of downtown San Francisco.\",\n  \"baseGuests\": 4,\n  \"cleaningFeeAmount\": 160,\n  \"baseDailyRate\": 220,\n  \"acceptInstantBook\": false,\n\t\"acceptBookingRequest\": false,\n  \"bathrooms\": \"2\",\n  \"maximumGuests\": 6,\n  \"state\": \"California\",\n  \"countryCode\": \"US\",\n  \"securityDepositAmount\": 500,\n  \"address1\": \"159 Campolindo Road\",\n  \"webLink\": \"http://point-reyes-vacation-rental.com/\",\n  \"address2\": \"\",\n  \"externalID\": \"\",\n  \"bedrooms\": 2,\n  \"type\": \"HOUSE\",\n  \"city\": \"Point Reyes Station\",\n  \"picture\": \"https://www.orbirental.com/img/uploader/livingroom4_1.jpg\",\n  \"postalCode\": \"94956\",\n  \"name\": \"The Quail's Nest Cottage\",\n  \"minimumStay\": 1,\n  \"maximumStay\": 0,\n  \"availabilityCalendarUrl\" : \"https://www.orbirental.com/calendar/232.ics\",\n  \"externalCalendarUrls\": [\n    {\n      \"name\": \"Wimdu\",\n      \"source\": \"IMPORT_OTHER_PROVIDER\",\n      \"url\": \"http://www.wimdu.com/offers/OOQHSNHS/calendar.ics?token=7ece1efghtr\"\n    }\n  ],\n  \"rules\": {\n    \"increaseRateLowerBound\": 6,\n    \"decreaseRateHigherBound\": 10,\n    \"increaseRate\": 15,\n    \"decreaseRate\": 20\n  },\n  \"floor\": 2,\n  \"areaSize\": 30,\n  \"areaSizeUnit\": \"SQUARE_METERS\",\n  \"extraGuestFee\": 50,\n  \"taxationRate\": 12.5,\n  \"longitude\" : 48.1914945,\n  \"latitude\" : 19.1914945,\n  \"currency\": \"USD\",\n  \"shortDescription\": \"This Point Reyes House is located on a quiet rural lane\",\n  \"panoramicDataUrl\": \"https://my.matterport.com/show/?m=123456\",\n  \"cancellationPolicy\": \"Here is the cancellation policy.\",\n  \"guideBookUrl\": \"https://v2.hostfully.com/california-dreaming\",\n  \"weekEndRatePercentAdjustment\": 10,\n  \"bookingWindowAfterCheckout\": 1,\n  \"turnOverDays\": 0,\n  \"bookingLeadTime\": 10,\n  \"defaultCheckinTime\": 15,\n  \"defaultCheckoutTime\": 10,\n  \"wifiNetwork\": \"network\",\n  \"wifiPassword\": \"password\",\n  \"onlyCheckInOnDay\": 1,\n  \"bedTypes\": {\n            \"doubleBed\": 0,\n            \"toddlerBed\": 0,\n            \"crib\": 0,\n            \"sofaBed\": 0,\n            \"queenBed\": 0,\n            \"kingBed\": 0,\n            \"futonBed\": 0,\n            \"airMattress\": 0,\n            \"floorMattress\": 0,\n            \"singleBed\": 4,\n            \"waterBed\": 0,\n            \"bunkBed\": 0,\n            \"hammockBed\": 0\n        },\n  \"bedCount\": 4,\n  \"rentalLicenseNumber\": \"12345\",\n  \"rentalLicenseNumberExpirationDate\": \"2020-01-01\",\n  \"minimumWeekendStay\": 2,\n  \"rentalConditions\": \"Rental Conditions of the Property\"\n}","language":"json"},{"code":"Orbirental API - Bad request.","language":"text","status":400,"name":""},{"code":"Orbirental API - Property not found.","language":"text","status":409}]},"settings":"","examples":{"codes":[]},"method":"put"},"next":{"description":"","pages":[]},"title":"/properties/:uid","type":"endpoint","slug":"properties-2","excerpt":"Edit the property associated with the provided unique id.","body":"","updates":[],"order":59,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5de85dbbb0b885003ddf3341","category":{"sync":{"isSync":false,"url":""},"pages":["5de85dbbb0b885003ddf3339","5de85dbbb0b885003ddf333a","5de85dbbb0b885003ddf333b","5de85dbbb0b885003ddf333c","5de85dbbb0b885003ddf333d","5de85dbbb0b885003ddf333e","5de85dbbb0b885003ddf333f","5de85dbbb0b885003ddf3340","5de85dbbb0b885003ddf3341","5de85dbbb0b885003ddf3342","5de85dbbb0b885003ddf3343","56e77e22911296190096de13","5de85dbbb0b885003ddf3344","5de85dbbb0b885003ddf3345","5de85dbbb0b885003ddf3346","5de85dbbb0b885003ddf3347","5de85dbbb0b885003ddf3348","5de85dbbb0b885003ddf3349","5de85dbbb0b885003ddf334a"],"title":"Documentation","slug":"documentation","order":0,"from_sync":false,"reference":false,"_id":"5de85dbbb0b885003ddf3334","project":"56e3719a591f620e00bf5095","__v":19,"createdAt":"2016-03-12T01:32:11.359Z","version":"5de85dbbb0b885003ddf339f"},"editedParams":true,"parentDoc":null,"user":"56e371538b32a10e00f79750","project":"56e3719a591f620e00bf5095","__v":22,"editedParams2":true,"githubsync":"","version":{"version":"1.5","version_clean":"1.5.0","codename":"Domain","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5de85dbbb0b885003ddf3334","56e7b24ad365390e007baeab","5de85dbbb0b885003ddf3335","5de85dbbb0b885003ddf3336","5de85dbbb0b885003ddf3337","5de85dbbb0b885003ddf3338"],"_id":"5de85dbbb0b885003ddf339f","__v":0,"project":"56e3719a591f620e00bf5095","forked_from":"56e3719a591f620e00bf5098","createdAt":"2016-03-12T01:32:10.751Z","releaseDate":"2016-03-12T01:32:10.751Z"},"createdAt":"2016-03-15T00:37:34.870Z"}

put/properties/:uid

Edit the property associated with the provided unique id.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

uid:
required
string
The unique id of the property

Body Params

type:
string
Can be HOUSE, COTTAGE, CONDO, BEDANDBREAKFAST, VILLA, CHALET, CABIN, STUDIO, ROOM, APARTMENT, OTHER
name:
string
The name of the property
baseGuests:
integer
The base number of guests
maximumGuests:
integer
The maximum number of guests
baseDailyRate:
double
The daily base rate
city:
string
The city in which this property is located
state:
string
The state in which this property is located
address1:
string
The addres of this property
address2:
string
The addres (line 2) of this property
postalCode:
string
The postal code of this property
countryCode:
string
Use an ISO_3166-1_alpha-2 format
bedrooms:
integer
The number of bedrooms in this property
bathrooms:
string
The number of bathrooms in this property
picture:
string
The picture URL of this property. Note that this URL will be overridden by the picture uploaded via the interface
webLink:
string
A web link representing this property
cleaningFeeAmount:
double
The amount of the cleaning fee
minimumStay:
integer
The minimum number of days for a stay
maximumStay:
integer0
The maximum stay number of days for a stay. Set to 0 for unlimited maximum stay
securityDepositAmount:
double
The amount of the security deposit
externalID:
string
A reference ID for this property in your own system
acceptInstantBook:
boolean
Whether this property accepts instant booking
isActive:
boolean
Whether this property is active
description:
string
Description of this property
floor:
integer
The floor of this property
areaSize:
integer
The area size of this property
areaSizeUnit:
string
Can be SQUARE_METERS or SQUARE_FEET
extraGuestFee:
double
The extra guest fee of this property
taxationRate:
double
The taxation rate of this property in percentage
latitude:
double
The latitude of this property
longitude:
double
The longitude of this property
shortDescription:
string
Short description of this property
panoramicDataUrl:
string
Panoramic URL
cancellationPolicy:
string
The cancellation policy
guideBookUrl:
string
Guide book URL
bookingWindow:
integer-1
Number of days in the future for which bookings are accepted. -1 means anytime, then 90, 180, 365 or 547 days
bookingWindowAfterCheckout:
integer-1
How far from the current date can a guest make a booking after each checkout
weekEndRatePercentAdjustment:
double0
Provides a rate adjustment for week-ends, in percentage
turnOverDays:
integer0
Number of days non-bookable between 2 bookings. 0, 1 or 2 days
bookingLeadTime:
integer48
Number of hours needed before check-in for accepting a booking. 0 to 24, 48, 72 or 168 hours
defaultCheckinTime:
integer15
The default checkin time for this property.
defaultCheckoutTime:
integer11
The default checkout time for this property.
wifiNetwork:
string
The name of the Wifi network at this property
wifiPassword:
string
The Wifi password at this property
onlyCheckInOnDay:
integer0
0 (No restriction) - 1 (Monday) - 2 (Tuesday) - 3 (Wednesday) - 4 (Thursday) - 5 (Friday) - 6 (Staturday) - 7 (Sunday)
currency:
string
currency of this property
rentalLicenseNumber:
string
Rental license number
rentalLicenseNumberExpirationDate:
yyyy-mm-dd
Rental licence number expiration date
minimumWeekendStay:
integer
Minimum weekend stay
rentalConditions:
string
Rental Conditions

Result Format


User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}