{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/leads/:uid","auth":"required","examples":{"codes":[]},"method":"delete","params":[{"name":"uid","type":"string","default":"","desc":"The unique ID of the lead to delete","required":true,"in":"path","ref":"","_id":"56e755b98aa2c00e00494cda"}],"results":{"codes":[{"name":"","code":"[\n  {\n    \"uid\": \"72852a55-5be3-496c-904c-fc3fd261f0a4\",\n    \"childrenCount\": 0,\n    \"lastName\": \"Raudin\",\n    \"checkInDate\": \"2016-03-08\",\n    \"checkOutDate\": \"2016-03-12\",\n    \"status\": \"BOOKED\",\n    \"adultCount\": 1,\n    \"agency\": {\n      \"uid\": \"4f6a3a32-6d57-450d-8b46-12547854\",\n      \"name\": \"Responseev\"\n    },\n    \"stayDetails\": {\n      \"arrivalTime\": \"15:00\",\n      \"departureTime\": \"11:00\"\n    },\n    \"property\": {\n      \"uid\": \"4f6a3a32-6d57-450d-8b46-44abb3b01994\",\n      \"isActive\": true,\n\t\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      \"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      \"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    },\n    \"notes\": \"\",\n    \"firstName\": \"Cedric\",\n    \"petCount\": 1,\n    \"quoteAmount\": 200\n  }\n]","language":"json","status":200},{"name":"","code":"Orbirental API - Bad request.","language":"text","status":400},{"language":"text","status":409,"name":null,"code":"Orbirental API - Lead not found."}]},"settings":""},"next":{"description":"","pages":[]},"title":"/leads/:uid","type":"endpoint","slug":"testinput-1","excerpt":"Delete a lead associated to the provided unique id","body":"","updates":[],"order":35,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5de85dbbb0b885003ddf333d","__v":1,"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"},"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"},"editedParams2":true,"parentDoc":null,"project":"56e3719a591f620e00bf5095","createdAt":"2016-03-15T00:22:17.739Z","editedParams":true,"githubsync":"","user":"56e371538b32a10e00f79750"}

delete/leads/:uid

Delete a lead associated to the provided unique id

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

uid:
required
string
The unique ID of the lead to delete

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