{"__v":9,"_id":"56e7593e1b41040e009d10cf","category":{"__v":19,"_id":"56e3719b591f620e00bf5099","pages":["56e3719c591f620e00bf509b","56e74226555c030e00a52a90","56e7447c7d693632001d5cb4","56e752bd56d59a0e00d5660e","56e755b98aa2c00e00494cd9","56e7584d911296190096dd80","56e759339b25270e001d11a0","56e7593e1b41040e009d10cf","56e7594e911296190096dd88","56e7595e8aa2c00e00494ce3","56e75d7f5669091700c5b2b4","56e77e22911296190096de13","56e77f259b25270e001d1232","56e7b2c737afb90e00e0eb9d","56ec4daf611730190000f23f","56ec4fde26db830e00afa083","56ec8f7204e8940e00966567","56f184cc9791b22d0077b9d9","56f18a2c3af4942b00bb3c47"],"project":"56e3719a591f620e00bf5095","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,"editedParams2":true,"parentDoc":null,"project":"56e3719a591f620e00bf5095","user":"56e371538b32a10e00f79750","version":{"__v":2,"_id":"56e3719a591f620e00bf5098","hasDoc":true,"hasReference":true,"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:18.199Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"results":{"codes":[{"status":200,"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  \"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":400,"language":"text","code":"Orbirental API - Bad request.","name":""},{"status":409,"language":"text","code":"Orbirental API - Agency not found."}]},"settings":"","auth":"required","params":[{"_id":"56e792971e071c22001a0488","ref":"","in":"body","required":true,"desc":"Can be HOUSE, COTTAGE, CONDO, BEDANDBREAKFAST, VILLA, CHALET, CABIN, STUDIO, ROOM, APARTMENT, HOTEL, LODGE, TOWNHOUSE, DUPLEX, TRIPLEX, FOURPLEX, BUNGALOW, BUNGALOW, FARMHOUSE, BOAT, HOUSEBOAT, RESORT, PENTHOUSE, CHATEAU, GUESTHOUSE, HOMESTAY, CAMPGROUND, MOTELROOM, COUNTRYHOUSE, OTHER","default":"","type":"string","name":"type"},{"_id":"56e788a19b25270e001d126a","ref":"","in":"body","required":true,"desc":"The name of the property","default":"","type":"string","name":"name"},{"_id":"56e788a19b25270e001d1269","ref":"","in":"body","required":true,"desc":"The unique id of the parent agency","default":"","type":"string","name":"agencyUid"},{"_id":"56e788a19b25270e001d1260","ref":"","in":"body","required":true,"desc":"The base number of guests","default":"","type":"int","name":"baseGuests"},{"_id":"56e788a19b25270e001d125f","ref":"","in":"body","required":true,"desc":"The maximum number of guests","default":"","type":"int","name":"maximumGuests"},{"_id":"56e788a19b25270e001d125b","ref":"","in":"body","required":true,"desc":"The daily base rate","default":"","type":"double","name":"baseDailyRate"},{"_id":"56e788a19b25270e001d1266","ref":"","in":"body","required":true,"desc":"The city in which this property is located","default":"","type":"string","name":"city"},{"_id":"56e788a19b25270e001d1264","ref":"","in":"body","required":true,"desc":"The state in which this property is located","default":"","type":"string","name":"state"},{"_id":"56e788a19b25270e001d1268","ref":"","in":"body","required":false,"desc":"The addres of this property","default":"","type":"string","name":"address1"},{"_id":"56e788a19b25270e001d1267","ref":"","in":"body","required":false,"desc":"The addres  (line 2) of this property","default":"","type":"string","name":"address2"},{"_id":"56e788a19b25270e001d1265","ref":"","in":"body","required":false,"desc":"The postal code of this property","default":"","type":"string","name":"postalCode"},{"_id":"56e788a19b25270e001d1263","ref":"","in":"body","required":false,"desc":"Use an ISO_3166-1_alpha-2 format","default":"","type":"string","name":"countryCode"},{"_id":"56e788a19b25270e001d1262","ref":"","in":"body","required":false,"desc":"The number of bedrooms in this property","default":"0","type":"int","name":"bedrooms"},{"_id":"56e788a19b25270e001d1261","ref":"","in":"body","required":false,"desc":"The number of bathrooms in this property","default":"0","type":"double","name":"bathrooms"},{"_id":"56e788a19b25270e001d125e","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":"56e788a19b25270e001d125d","ref":"","in":"body","required":false,"desc":"A web link representing this property","default":"","type":"string","name":"webLink"},{"_id":"56e788a19b25270e001d125c","ref":"","in":"body","required":false,"desc":"The amount of the cleaning fee","default":"0","type":"double","name":"cleaningFeeAmount"},{"_id":"56e788a19b25270e001d125a","ref":"","in":"body","required":false,"desc":"The minimum number of days for a stay","default":"2","type":"int","name":"minimumStay"},{"_id":"56e788a19b25270e001d1259","ref":"","in":"body","required":false,"desc":"The amount of the security deposit","default":"0","type":"double","name":"securityDepositAmount"},{"_id":"56e788a19b25270e001d1258","ref":"","in":"body","required":false,"desc":"A reference ID for this property in your own system","default":"","type":"string","name":"externalID"},{"_id":"56e788a19b25270e001d1257","ref":"","in":"body","required":false,"desc":"Whether this property accepts instant booking","default":"false","type":"boolean","name":"acceptInstantBook"},{"_id":"56f1ab820157b9200072df20","ref":"","in":"body","required":false,"desc":"Whether this property is active","default":"true","type":"boolean","name":"isActive"},{"_id":"56f1ab820157b9200072df1f","ref":"","in":"body","required":false,"desc":"Description of the property","default":"","type":"string","name":"description"},{"_id":"56f458ec2509363200e07f0d","ref":"","in":"body","required":false,"desc":"The floor of this property","default":"","type":"int","name":"floor"},{"_id":"56f458ec2509363200e07f0c","ref":"","in":"body","required":false,"desc":"The area size of this property","default":"","type":"int","name":"areaSize"},{"_id":"56f458ec2509363200e07f0b","ref":"","in":"body","required":false,"desc":"Can be SQUARE_METERS or SQUARE_FEET","default":"SQUARE_FEET","type":"string","name":"areaSizeUnit"},{"_id":"56f476b22c02aa3400ab4983","ref":"","in":"body","required":false,"desc":"The extra guest fee of this property","default":"0","type":"double","name":"extraGuestFee"},{"_id":"56f47f49757a450e0072d6ad","ref":"","in":"body","required":false,"desc":"The taxation rate of this property in percentage","default":"","type":"double","name":"taxationRate"},{"_id":"570d866880c9010e00d77f6e","ref":"","in":"body","required":false,"desc":"The latitude of this property","default":"","type":"double","name":"latitude"},{"_id":"570d866880c9010e00d77f6d","ref":"","in":"body","required":false,"desc":"The longitude of this property","default":"","type":"double","name":"longitude"},{"_id":"583cfe4aaffe9b230028567b","ref":"","in":"body","required":false,"desc":"Short description of the property","default":"","type":"string","name":"shortDescription"},{"_id":"583cfe4aaffe9b230028567a","ref":"","in":"body","required":false,"desc":"Panoramic URL","default":"","type":"string","name":"panoramicDataUrl"},{"_id":"583cfe4aaffe9b2300285679","ref":"","in":"body","required":false,"desc":"Cancellation policy","default":"","type":"string","name":"cancellationPolicy"}],"url":"/properties"},"isReference":false,"order":25,"body":"","excerpt":"Create a new property","slug":"properties-1","type":"post","title":"/properties"}

post/properties

Create a new property

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

type:
required
string
Can be HOUSE, COTTAGE, CONDO, BEDANDBREAKFAST, VILLA, CHALET, CABIN, STUDIO, ROOM, APARTMENT, HOTEL, LODGE, TOWNHOUSE, DUPLEX, TRIPLEX, FOURPLEX, BUNGALOW, BUNGALOW, FARMHOUSE, BOAT, HOUSEBOAT, RESORT, PENTHOUSE, CHATEAU, GUESTHOUSE, HOMESTAY, CAMPGROUND, MOTELROOM, COUNTRYHOUSE, OTHER
name:
required
string
The name of the property
agencyUid:
required
string
The unique id of the parent agency
baseGuests:
required
integer
The base number of guests
maximumGuests:
required
integer
The maximum number of guests
baseDailyRate:
required
double
The daily base rate
city:
required
string
The city in which this property is located
state:
required
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:
integer0
The number of bedrooms in this property
bathrooms:
double0
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:
double0
The amount of the cleaning fee
minimumStay:
integer2
The minimum number of days for a stay
securityDepositAmount:
double0
The amount of the security deposit
externalID:
string
A reference ID for this property in your own system
acceptInstantBook:
booleanfalse
Whether this property accepts instant booking
isActive:
booleantrue
Whether this property is active
description:
string
Description of the property
floor:
integer
The floor of this property
areaSize:
integer
The area size of this property
areaSizeUnit:
stringSQUARE_FEET
Can be SQUARE_METERS or SQUARE_FEET
extraGuestFee:
double0
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 the property
panoramicDataUrl:
string
Panoramic URL
cancellationPolicy:
string
Cancellation policy

Result Format


User Information

Try It Out

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