{"_id":"56e752bd56d59a0e00d5660e","editedParams":true,"githubsync":"","user":"56e371538b32a10e00f79750","parentDoc":null,"__v":15,"editedParams2":true,"version":{"_id":"56e3719a591f620e00bf5098","hasReference":true,"hasDoc":true,"__v":6,"project":"56e3719a591f620e00bf5095","createdAt":"2016-03-12T01:32:10.751Z","releaseDate":"2016-03-12T01:32:10.751Z","categories":["56e3719b591f620e00bf5099","56e7b24ad365390e007baeab","59c952f57f6bea002e57da0a","59c954f07f6bea002e57da14","59cb3f6b487a0e00261deb5c","59cd714c360c8600242c4984"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.1.0","version":"1.1"},"project":"56e3719a591f620e00bf5095","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"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-15T00:09:33.637Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"put","results":{"codes":[{"name":"","code":"{\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  \"source\": \"ORBIRENTAL_FORM\",\n  \"property\": {\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    \"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\t\t\"areaSize\": 30,\n\t\t\"areaSizeUnit\": \"SQUARE_METERS\",\n    \"extraGuestFee\": 50,\n    \"taxationRate\": 12.5,\n    \"longitude\" : 48.1914945,\n    \"latitude\" : 19.1914945,\n    \"currency\": \"USD\"\n  },\n  \"stayDetails\": {\n       \"departureDate\": \"2017-02-25 11:00:00.0\",\n       \"arrivalDate\": \"2017-02-24 15:00:00.0\",\n       \"extraNotes\": \"Some notes\"\n  },\n  \"notes\": \"\",\n  \"phoneNumber\": \"415-322-2422\",\n  \"cellphoneNumber\": \"415-888-6658\",\n  \"firstName\": \"Cedric\",\n  \"flightNumber\": \"XTF1PNS\",\n  \"reasonForTrip\": \"Business\",\n  \"preferredCurrency\": \"USD\",\n  \"petCount\": 1,\n  \"quoteAmount\": 200,\n  \"city\": \"Irvine\",\n  \"state\": \"California\",\n   \"secondaryEmail\": \"mike:::at:::guest.airbnb.com\"\n}","language":"json","status":200},{"name":"","code":"Orbirental API - Bad request.","language":"text","status":400},{"code":"Orbirental API - Lead not found.","language":"text","status":409}]},"settings":"","auth":"required","params":[{"_id":"56e752bd56d59a0e00d5660f","ref":"","in":"path","required":true,"desc":"Unique id of the lead","default":"","type":"string","name":"uid"},{"_id":"5877253bc24bcb0f000d8371","ref":"","in":"body","required":false,"desc":"Unique id of the property","default":"","type":"string","name":"propertyUid"},{"_id":"56e7447c7d693632001d5cbd","ref":"","in":"body","required":false,"desc":"Check-in date with format YYYY-MM-DD","default":"","type":"yyyy-mm-dd","name":"checkInDate"},{"_id":"56e7447c7d693632001d5cbc","ref":"","in":"body","required":false,"desc":"Check-out date with format YYYY-MM-DD","default":"","type":"yyyy-mm-dd","name":"checkOutDate"},{"_id":"56e7447c7d693632001d5cbb","ref":"","in":"body","required":false,"desc":"Email of the guest","default":"","type":"string","name":"email"},{"_id":"56e7acaf5f6fe60e00a2d974","ref":"","in":"body","required":false,"desc":"Status of the lead: BOOKED | BLOCKED | PAID_IN_FULL | CANCELLED","default":"","type":"string","name":"status"},{"_id":"56e7ad118e49c80e00402efc","ref":"","in":"body","required":false,"desc":"First name of the guest","default":"","type":"string","name":"firstName"},{"_id":"56e7ad6d8e49c80e00402f09","ref":"","in":"body","required":false,"desc":"Last name of the guest","default":"","type":"string","name":"lastName"},{"_id":"56e7ad6d8e49c80e00402f08","ref":"","in":"body","required":false,"desc":"Number of adults","default":"","type":"int","name":"adultCount"},{"_id":"56e7ad6d8e49c80e00402f07","ref":"","in":"body","required":false,"desc":"Number of children","default":"","type":"int","name":"childrenCount"},{"_id":"56e7ad6d8e49c80e00402f06","ref":"","in":"body","required":false,"desc":"Number of pets","default":"","type":"int","name":"petCount"},{"_id":"56e7ad6d8e49c80e00402f05","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"externalBookingID"},{"_id":"56e7ad6d8e49c80e00402f04","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"referrer"},{"_id":"56e7ad6d8e49c80e00402f03","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"notes"},{"_id":"5b653497a3befb0003b5b7d1","ref":"","in":"body","required":false,"desc":"Lead's extra notes.","default":"","type":"string","name":"extraNotes"},{"_id":"56e7ad6d8e49c80e00402f02","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"phoneNumber"},{"_id":"5b653497a3befb0003b5b7d0","ref":"","in":"body","required":false,"desc":"Cell Phone Number associated with this lead","default":"","type":"string","name":"cellphoneNumber"},{"_id":"56e7ad6d8e49c80e00402f01","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"address1"},{"_id":"56e7ad6d8e49c80e00402f00","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"address2"},{"_id":"5b653497a3befb0003b5b7cf","ref":"","in":"body","required":false,"desc":"City associated to this lead.","default":"","type":"string","name":"city"},{"_id":"5b653497a3befb0003b5b7ce","ref":"","in":"body","required":false,"desc":"State associated with this lead.","default":"","type":"string","name":"state"},{"_id":"56e7ad6d8e49c80e00402eff","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"postalCode"},{"_id":"56e7ad6d8e49c80e00402efe","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"countryCode"},{"_id":"56e7ad6d8e49c80e00402efd","ref":"","in":"body","required":false,"desc":"","default":"","type":"double","name":"quoteAmount"},{"_id":"595d1c239d4fd400519ad401","ref":"","in":"body","required":false,"desc":"arrival time with format HH:mm","default":"","type":"string","name":"arrivalTime"},{"_id":"595d1c239d4fd400519ad400","ref":"","in":"body","required":false,"desc":"arrival time with format HH:mm","default":"","type":"string","name":"departureTime"},{"_id":"5a0af723751af7003c0af9ef","ref":"","in":"body","required":false,"desc":"Security deposit amount","default":"","type":"double","name":"securityDepositAmount"},{"_id":"5b653497a3befb0003b5b7cd","ref":"","in":"body","required":false,"desc":"Flight Number associated this this lead.","default":"","type":"string","name":"flightNumber"},{"_id":"5b653497a3befb0003b5b7cc","ref":"","in":"body","required":false,"desc":"Lead's reason for the trip","default":"","type":"string","name":"reasonForTrip"},{"_id":"5b653497a3befb0003b5b7cb","ref":"","in":"body","required":false,"desc":"Preferred Currency of the lead.","default":"","type":"string","name":"preferredCurrency"}],"url":"/leads/:uid"},"isReference":false,"order":27,"body":"**DATA FORMAT**\nNote also that the data has to be provided in **JSON format**. If you were to send a CURL request, this is an example of how it would be formatted:\n\ncurl -k -X POST \\\n  http://api.sandbox.orbirental.com/v1/guest \\\n  -H 'Cache-Control: no-cache' \\\n  -H 'Content-Type: application/json' \\\n  -H 'X-ORBIRENTAL-APIKEY: <YOUR_API_KEY>' \\\n  -d '{\n        \"agencyUid\":\"<YOUR_AGENCY_UID>\",\n        \"email\":\"test@test.com\",\n        \"firstName\":\"Test\"\n}'\n\n**LOCKED PARAMETERS**\nNote that the values for checkInDate, checkOutDate, adultCount, childrenCount and quoteAmount can not be modified unless the lead has the NEW status. Those can not be changed once the lead is booked.","excerpt":"Edit a lead associated to the provided unique id","slug":"leads-1","type":"endpoint","title":"/leads/:uid"}

put/leads/:uid

Edit a lead associated to the provided unique id

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

uid:
required
string
Unique id of the lead

Body Params

propertyUid:
string
Unique id of the property
checkInDate:
yyyy-mm-dd
Check-in date with format YYYY-MM-DD
checkOutDate:
yyyy-mm-dd
Check-out date with format YYYY-MM-DD
email:
string
Email of the guest
status:
string
Status of the lead: BOOKED | BLOCKED | PAID_IN_FULL | CANCELLED
firstName:
string
First name of the guest
lastName:
string
Last name of the guest
adultCount:
integer
Number of adults
childrenCount:
integer
Number of children
petCount:
integer
Number of pets
externalBookingID:
string
referrer:
string
notes:
string
extraNotes:
string
Lead's extra notes.
phoneNumber:
string
cellphoneNumber:
string
Cell Phone Number associated with this lead
address1:
string
address2:
string
city:
string
City associated to this lead.
state:
string
State associated with this lead.
postalCode:
string
countryCode:
string
quoteAmount:
double
arrivalTime:
string
arrival time with format HH:mm
departureTime:
string
arrival time with format HH:mm
securityDepositAmount:
double
Security deposit amount
flightNumber:
string
Flight Number associated this this lead.
reasonForTrip:
string
Lead's reason for the trip
preferredCurrency:
string
Preferred Currency of the lead.

Result Format


Documentation

**DATA FORMAT** Note also that the data has to be provided in **JSON format**. If you were to send a CURL request, this is an example of how it would be formatted: curl -k -X POST \ http://api.sandbox.orbirental.com/v1/guest \ -H 'Cache-Control: no-cache' \ -H 'Content-Type: application/json' \ -H 'X-ORBIRENTAL-APIKEY: <YOUR_API_KEY>' \ -d '{ "agencyUid":"<YOUR_AGENCY_UID>", "email":"test@test.com", "firstName":"Test" }' **LOCKED PARAMETERS** Note that the values for checkInDate, checkOutDate, adultCount, childrenCount and quoteAmount can not be modified unless the lead has the NEW status. Those can not be changed once the lead is booked.

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