{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/guests","auth":"required","examples":{"codes":[]},"method":"put","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"lastLogin\": \"2018-05-20 10:36:19.0\",\n    \"lastName\": \"GuestLast\",\n    \"zipCode\": \"08837\",\n    \"linkedinURL\": \"www.linkedin.com/guestprofile\",\n    \"city\": \"California\",\n    \"airbnbID\": \"airbnbID\",\n    \"mobileNumber\": \"0987654321\",\n    \"pictureURL\": \"www.guestwebsite.com/image.jpg\",\n    \"adress\": \"Menlo Park\",\n    \"birthDate\": \"4 Dec 1994\",\n    \"favoriteAirline\": \"Alaska Airline\",\n    \"firstName\": \"GuestFirstName\",\n    \"registrationToken\": \"NdbgHLH4Fa\",\n    \"skypeID\": \"skyoe_guest\",\n    \"facebookURL\": \"www.facebook.com/guestprofile\",\n    \"createdDate\": \"2018-05-20 10:33:41.0\",\n    \"phoneNumber\": \"123456789\",\n    \"agencyUid\": \"47d5b235-c98a-42c2-af89-b3bab325a7ff\",\n    \"modifiedDate\": \"Sun May 20 10:38:37 IST 2018\",\n    \"profileNotes\": \"These are the notes of the Guest Account\",\n    \"id\": 57473,\n    \"state\": \"California\",\n    \"email\": \"guestemailid:::at:::guestcompany.com\",\n  \t\"uid\": \"47d5b235-c98a-42c2-af89-b3bab325a7ff\"\n}","name":""},{"status":400,"language":"text","code":"Orbirental API - Bad request."},{"status":409,"language":"text","code":"Orbirental API - Authorization Header missing.\n\nOrbirental API - Credentials missing.\n\nOrbirental API - Guest with provided email not found.\n\nOrbirental API - Email Address Cannot be changed.\n\nOrbirental API - Agency with the given agencyUid not found\n\nOrbirental API - Incorrectly defined password.\n\nOrbirental API - Incorrect AffiliateID.\n\nOrbirental API - Invalid Password."}]},"settings":"5b00f60a5927b700035262d3","params":[{"name":"agencyUid","type":"string","default":"","desc":"The unique Agency Uid","required":true,"in":"body","ref":"","_id":"5b00f98067a5af0003317524"},{"name":"firstName","type":"string","default":"","desc":"First Name of the Guest","required":false,"in":"body","ref":"","_id":"5b00f98067a5af0003317522"},{"name":"password","type":"string","default":"","desc":"Password of the Guest account","required":false,"in":"body","ref":"","_id":"5b00f98067a5af0003317521"},{"name":"affiliateID","type":"string","default":"","desc":"Affiliate ID","required":false,"in":"body","ref":"","_id":"5b00f98067a5af0003317520"},{"name":"lastName","type":"string","default":"","desc":"Last Name of the Guest","required":false,"in":"body","ref":"","_id":"5b00f98067a5af000331751f"},{"name":"phoneNumber","type":"string","default":"","desc":"Phone Number of the Guest","required":false,"in":"body","ref":"","_id":"5b00f98067a5af000331751e"},{"name":"mobileNumber","type":"string","default":"","desc":"Mobile Number of the Guest","required":false,"in":"body","ref":"","_id":"5b00f98067a5af000331751d"},{"name":"address","type":"string","default":"","desc":"Address of the Guest","required":false,"in":"body","ref":"","_id":"5b00f98067a5af000331751c"},{"name":"city","type":"string","default":"","desc":"City corresponding to the address","required":false,"in":"body","ref":"","_id":"5b00f98067a5af000331751b"},{"name":"zipCode","type":"string","default":"","desc":"ZipCode of the city","required":false,"in":"body","ref":"","_id":"5b00f98067a5af000331751a"},{"name":"state","type":"string","default":"","desc":"State in which the city is present","required":false,"in":"body","ref":"","_id":"5b00f98067a5af0003317519"},{"name":"countryCode","type":"string","default":"","desc":"Country of the address","required":false,"in":"body","ref":"","_id":"5b00f98067a5af0003317518"},{"name":"pictureURL","type":"string","default":"","desc":"Guest's picture URL","required":false,"in":"body","ref":"","_id":"5b00f98067a5af0003317517"},{"name":"facebookURL","type":"string","default":"","desc":"Facebook profile URL","required":false,"in":"body","ref":"","_id":"5b00f98067a5af0003317516"},{"name":"twitterHandle","type":"string","default":"","desc":"Twitter Handle of Guest","required":false,"in":"body","ref":"","_id":"5b00f98067a5af0003317515"},{"name":"linkedInURL","type":"string","default":"","desc":"LinkedIn profile Link","required":false,"in":"body","ref":"","_id":"5b00f98067a5af0003317514"},{"name":"airbnbID","type":"string","default":"","desc":"AirBnB ID","required":false,"in":"body","ref":"","_id":"5b00f98067a5af0003317513"},{"name":"skypeID","type":"string","default":"","desc":"SkypeId of guest","required":false,"in":"body","ref":"","_id":"5b00f98067a5af0003317512"},{"name":"favoriteAirline","type":"string","default":"","desc":"Favorite Airline by which guest likes to travel","required":false,"in":"body","ref":"","_id":"5b00f98067a5af0003317511"},{"name":"profileNotes","type":"string","default":"","desc":"The profile Note of the guest","required":false,"in":"body","ref":"","_id":"5b00f98067a5af0003317510"},{"name":"dateOfBirth","type":"string","default":"","desc":"Date of Birth of the Guest","required":false,"in":"body","ref":"","_id":"5b00f98067a5af000331750f"},{"name":"email","type":"string","default":"","desc":"New Email of the Guest","required":false,"in":"body","ref":"","_id":"5b0d831125c16000033521cb"}]},"next":{"description":"","pages":[]},"title":"/guests","type":"endpoint","slug":"guest-3","excerpt":"Update Guest Account","body":"","updates":[],"order":24,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5de85dbbb0b885003ddf3383","project":"56e3719a591f620e00bf5095","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"},"user":"5ad0d1d6d24f9c0003476a4c","createdAt":"2018-05-20T04:43:32.571Z","githubsync":"","__v":8,"parentDoc":null}

put/guests

Update Guest Account

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

agencyUid:
required
string
The unique Agency Uid
firstName:
string
First Name of the Guest
password:
string
Password of the Guest account
affiliateID:
string
Affiliate ID
lastName:
string
Last Name of the Guest
phoneNumber:
string
Phone Number of the Guest
mobileNumber:
string
Mobile Number of the Guest
address:
string
Address of the Guest
city:
string
City corresponding to the address
zipCode:
string
ZipCode of the city
state:
string
State in which the city is present
countryCode:
string
Country of the address
pictureURL:
string
Guest's picture URL
facebookURL:
string
Facebook profile URL
twitterHandle:
string
Twitter Handle of Guest
linkedInURL:
string
LinkedIn profile Link
airbnbID:
string
AirBnB ID
skypeID:
string
SkypeId of guest
favoriteAirline:
string
Favorite Airline by which guest likes to travel
profileNotes:
string
The profile Note of the guest
dateOfBirth:
string
Date of Birth of the Guest
email:
string
New Email of the Guest

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