{"_id":"56e7594e911296190096dd88","category":{"_id":"56e3719b591f620e00bf5099","pages":["56e3719c591f620e00bf509b","56e74226555c030e00a52a90","56e7447c7d693632001d5cb4","56e752bd56d59a0e00d5660e","56e755b98aa2c00e00494cd9","56e7584d911296190096dd80","56e759339b25270e001d11a0","56e7593e1b41040e009d10cf","56e7594e911296190096dd88","56e7595e8aa2c00e00494ce3","56e75d7f5669091700c5b2b4","56e77e22911296190096de13","56e77f259b25270e001d1232","56e7b2c737afb90e00e0eb9d","56ec4daf611730190000f23f","56ec4fde26db830e00afa083","56ec8f7204e8940e00966567","56f184cc9791b22d0077b9d9","56f18a2c3af4942b00bb3c47"],"project":"56e3719a591f620e00bf5095","__v":19,"version":"56e3719a591f620e00bf5098","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-03-12T01:32:11.359Z","from_sync":false,"order":0,"slug":"documentation","title":"Documentation"},"editedParams":true,"parentDoc":null,"user":"56e371538b32a10e00f79750","project":"56e3719a591f620e00bf5095","__v":8,"editedParams2":true,"version":{"_id":"56e3719a591f620e00bf5098","hasReference":true,"hasDoc":true,"__v":2,"project":"56e3719a591f620e00bf5095","createdAt":"2016-03-12T01:32:10.751Z","releaseDate":"2016-03-12T01:32:10.751Z","categories":["56e3719b591f620e00bf5099","56e7b24ad365390e007baeab"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.1.0","version":"1.1"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-15T00:37:34.870Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"language":"json","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  \"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  \"availabilityCalendarUrl\" : \"https://www.orbirental.com/calendar/232.ics\",\n  \"photos\": [\n    {\n      \"url\": \"https://www.orbirental.com/img/uploader/view_0.jpg\",\n      \"description\" : \"my house\"\n    }\n  ],\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}","name":"","status":200},{"name":"","status":400,"language":"text","code":"Orbirental API - Bad request."},{"status":409,"language":"text","code":"Orbirental API - Property not found."}]},"settings":"","examples":{"codes":[]},"method":"put","auth":"required","params":[{"_id":"56e795d715f96b2200878e48","ref":"","in":"path","required":true,"desc":"The unique id of the property","default":"","type":"string","name":"uid"},{"_id":"56e795d715f96b2200878e47","ref":"","in":"body","required":false,"desc":"Can be HOUSE,  COTTAGE,  CONDO,  BEDANDBREAKFAST,         VILLA,      CHALET, CABIN, STUDIO, ROOM, APARTMENT, OTHER","default":"","type":"string","name":"type"},{"_id":"56e795d715f96b2200878e46","ref":"","in":"body","required":false,"desc":"The name of the property","default":"","type":"string","name":"name"},{"_id":"56e795d715f96b2200878e45","ref":"","in":"body","required":false,"desc":"The base number of guests","default":"","type":"int","name":"baseGuests"},{"_id":"56e795d715f96b2200878e44","ref":"","in":"body","required":false,"desc":"The maximum number of guests","default":"","type":"int","name":"maximumGuests"},{"_id":"56e795d715f96b2200878e43","ref":"","in":"body","required":false,"desc":"The daily base rate","default":"","type":"double","name":"baseDailyRate"},{"_id":"56e795d715f96b2200878e42","ref":"","in":"body","required":false,"desc":"The city in which this property is located","default":"","type":"string","name":"city"},{"_id":"56e795d715f96b2200878e41","ref":"","in":"body","required":false,"desc":"The state in which this property is located","default":"","type":"string","name":"state"},{"_id":"56e795d715f96b2200878e40","ref":"","in":"body","required":false,"desc":"The addres of this property","default":"","type":"string","name":"address1"},{"_id":"56e795d715f96b2200878e3f","ref":"","in":"body","required":false,"desc":"The addres  (line 2) of this property","default":"","type":"string","name":"address2"},{"_id":"56e795d715f96b2200878e3e","ref":"","in":"body","required":false,"desc":"The postal code of this property","default":"","type":"string","name":"postalCode"},{"_id":"56e795d715f96b2200878e3d","ref":"","in":"body","required":false,"desc":"Use an ISO_3166-1_alpha-2 format","default":"","type":"string","name":"countryCode"},{"_id":"56e795d715f96b2200878e3c","ref":"","in":"body","required":false,"desc":"The number of bedrooms in this property","default":"","type":"int","name":"bedrooms"},{"_id":"56e795d715f96b2200878e3b","ref":"","in":"body","required":false,"desc":"The number of bathrooms in this property","default":"","type":"string","name":"bathrooms"},{"_id":"56e795d715f96b2200878e3a","ref":"","in":"body","required":false,"desc":"The picture URL of this property. Note that this URL will be overridden by the picture uploaded via the interface","default":"","type":"string","name":"picture"},{"_id":"56e795d715f96b2200878e39","ref":"","in":"body","required":false,"desc":"A web link representing this property","default":"","type":"string","name":"webLink"},{"_id":"56e795d715f96b2200878e38","ref":"","in":"body","required":false,"desc":"The amount of the cleaning fee","default":"","type":"double","name":"cleaningFeeAmount"},{"_id":"56e795d715f96b2200878e37","ref":"","in":"body","required":false,"desc":"The minimum number of days for a stay","default":"","type":"int","name":"minimumStay"},{"_id":"56e795d715f96b2200878e36","ref":"","in":"body","required":false,"desc":"The amount of the security deposit","default":"","type":"double","name":"securityDepositAmount"},{"_id":"56e795d715f96b2200878e35","ref":"","in":"body","required":false,"desc":"A reference ID for this property in your own system","default":"","type":"string","name":"externalID"},{"_id":"56e795d715f96b2200878e34","ref":"","in":"body","required":false,"desc":"Whether this property accepts instant booking","default":"","type":"boolean","name":"acceptInstantBook"},{"_id":"56f1abc14476fb2200795e68","ref":"","in":"body","required":false,"desc":"Whether this property is active","default":"","type":"boolean","name":"isActive"},{"_id":"56f1abc14476fb2200795e67","ref":"","in":"body","required":false,"desc":"Description of this property","default":"","type":"string","name":"description"},{"_id":"56f45a12b6a1522900aedef5","ref":"","in":"body","required":false,"desc":"The floor of this property","default":"","type":"int","name":"floor"},{"_id":"56f45a12b6a1522900aedef4","ref":"","in":"body","required":false,"desc":"The area size of this property","default":"","type":"int","name":"areaSize"},{"_id":"56f45a12b6a1522900aedef3","ref":"","in":"body","required":false,"desc":"Can be SQUARE_METERS or SQUARE_FEET","default":"","type":"string","name":"areaSizeUnit"},{"_id":"56f476deab3f610e000a6474","ref":"","in":"body","required":false,"desc":"The extra guest fee of this property","default":"","type":"double","name":"extraGuestFee"},{"_id":"56f47f296bd7a20e00d22b24","ref":"","in":"body","required":false,"desc":"The taxation rate of this property in percentage","default":"","type":"double","name":"taxationRate"},{"_id":"570d86a6d1e4b82000d9e3ac","ref":"","in":"body","required":false,"desc":"The latitude of this property","default":"","type":"double","name":"latitude"},{"_id":"570d86a6d1e4b82000d9e3ab","ref":"","in":"body","required":false,"desc":"The longitude of this property","default":"","type":"double","name":"longitude"},{"_id":"583cfefc005871230068d9b7","ref":"","in":"body","required":false,"desc":"Short description of this property","default":"","type":"string","name":"shortDescription"},{"_id":"583cfefc005871230068d9b6","ref":"","in":"body","required":false,"desc":"Panoramic URL","default":"","type":"string","name":"panoramicDataUrl"},{"_id":"583cfefc005871230068d9b5","ref":"","in":"body","required":false,"desc":"The cancellation policy","default":"","type":"string","name":"cancellationPolicy"}],"url":"/properties/:uid"},"isReference":false,"order":30,"body":"","excerpt":"Edit the property associated with the provided unique id.","slug":"properties-2","type":"endpoint","title":"/properties/:uid"}

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
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

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 }}