{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/properties/:uid","auth":"required","results":{"codes":[{"name":"","code":"[\n  {\n    \"uid\": \"4f6a3a32-6d57-450d-8b46-44abb3b01994\",\n    \"isActive\": true,\n\t\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    \"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    \"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        \"uid\": \"d1011595-98eb-4bc7-9e5b-7e914798e56c\",\n    \t\t\"displayOrder\": 1\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  \t\"areaSize\": 30,\n  \t\"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  \t\"panoramicDataUrl\": \"https://my.matterport.com/show/?m=123456\",\n \t\t\"cancellationPolicy\": \"Here is the cancellation policy.\",\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\": 1,\n            \"kingBed\": 0,\n            \"futonBed\": 0,\n            \"airMattress\": 0,\n            \"floorMattress\": 0,\n            \"singleBed\": 2,\n            \"waterBed\": 0,\n            \"bunkBed\": 0,\n            \"hammockBed\": 0\n        },\n    \"bedCount\": 3,\n    \"rentalLicenseNumber\": \"12345\",\n    \"rentalLicenseNumberExpirationDate\": \"2020-01-01\",\n    \"minimumWeekendStay\": 2\n\t}\n]","language":"json","status":200},{"name":"","code":"Orbirental API - Bad request.","language":"text","status":400},{"code":"Orbirental API - Property not found.","language":"text","status":409}]},"settings":"","examples":{"codes":[]},"method":"delete","params":[{"name":"uid","type":"string","default":"","desc":"The unique id of the property","required":true,"in":"path","ref":"","_id":"56e7974d911296190096de57"}]},"next":{"description":"","pages":[]},"title":"/properties/:uid","type":"endpoint","slug":"properties-3","excerpt":"Delete a property associated with the provided unique id.","body":"","updates":[],"order":60,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5de85dbbb0b885003ddf3342","__v":9,"parentDoc":null,"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,"githubsync":"","project":"56e3719a591f620e00bf5095","user":"56e371538b32a10e00f79750","createdAt":"2016-03-15T00:37:50.121Z","editedParams2":true,"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"}}

delete/properties/:uid

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

Result Format


User Information

Try It Out

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