Sign in

v1

latestOpenAPI 3.0.32026-07-2632131.4 MB
Guests

Update guest

Update guest

put/guests-crud/{guestId}

Path parameters

guestIdstring required

Guest id

Request body

firstNamestring
lastNamestring
hometownstring
pictureobject

A link to guest’s picture in different sizes

emailstring

The main contact email of the guest

emailsstring[]

List of additional emails of the guest

phonestring

The main contact phone number

phonesstring[]

List of additional phone numbers of the guest

notesstring

Attention notes about the guest, describing important pieces of information about the guest, to review for all reservations (e.g. “Requires accessibility equipment”). Displayed as “Attention notes” in the user interface.

tagsstring[] required

Tags for describing the guest at a glance + show the enum for the field to show the allowed options

goodToKnowNotesstring

“Good to know” notes about the guest. Notes to help capture facts about the guest that will help the team to personalize the guest’s stays (e.g. “Big football fan”)

preferredLanguage'en' | 'es' | 'fr' | 'ma' | 'aa' | 'ab' | 'ae' | 'af' | 'ak' | 'am' | 'an' | 'ar' | 'as' | 'av' | 'ay' | 'az' | 'ba' | 'be' | 'bg' | 'bh' | 'bi' | 'bm' | 'bn' | 'bo' | 'br' | 'bs' | 'ca' | 'ce' | 'ch' | 'co' | 'cr' | 'cs' | 'cu' | 'cv' | 'cy' | 'da' | 'de' | 'dv' | 'dz' | 'ee' | 'el' | 'eo' | 'et' | 'eu' | 'fa' | 'ff' | 'fi' | 'fj' | 'fo' | 'fy' | 'ga' | 'gd' | 'gl' | 'gn' | 'gu' | 'gv' | 'ha' | 'he' | 'hi' | 'ho' | 'hr' | 'ht' | 'hu' | 'hy' | 'hz' | 'ia' | 'id' | 'ie' | 'ig' | 'ii' | 'ik' | 'io' | 'is' | 'it' | 'iu' | 'ja' | 'jv' | 'ka' | 'kg' | 'ki' | 'kj' | 'kk' | 'kl' | 'km' | 'kn' | 'ko' | 'kr' | 'ks' | 'ku' | 'kv' | 'kw' | 'ky' | 'la' | 'lb' | 'lg' | 'li' | 'ln' | 'lo' | 'lt' | 'lu' | 'lv' | 'mg' | 'mh' | 'mi' | 'mk' | 'ml' | 'mn' | 'mr' | 'ms' | 'mt' | 'my' | 'na' | 'nb' | 'nd' | 'ne' | 'ng' | 'nl' | 'nn' | 'no' | 'nr' | 'nv' | 'ny' | 'oc' | 'oj' | 'om' | 'or' | 'os' | 'pa' | 'pi' | 'pl' | 'ps' | 'pt' | 'qu' | 'rm' | 'rn' | 'ro' | 'ru' | 'rw' | 'sa' | 'sc' | 'sd' | 'se' | 'sg' | 'si' | 'sk' | 'sl' | 'sm' | 'sn' | 'so' | 'sq' | 'sr' | 'ss' | 'st' | 'su' | 'sv' | 'sw' | 'ta' | 'te' | 'tg' | 'th' | 'ti' | 'tk' | 'tl' | 'tn' | 'to' | 'tr' | 'ts' | 'tt' | 'tw' | 'ty' | 'ug' | 'uk' | 'ur' | 'uz' | 've' | 'vi' | 'vo' | 'wa' | 'wo' | 'xh' | 'yi' | 'yo' | 'za' | 'zh' | 'zu'
birthdaystring date-time
gender'male' | 'female' | 'other'
maritalStatus'single' | 'married' | 'widowed' | 'separated' | 'divorced'
dietaryPreferencesstring[]

You can pick one of the predefined options, or create a new one for your account

allergiesstring[]

You can pick one of the predefined options, or create a new one for your account

interestsstring[]

You can pick one of the predefined options, or create a new one for your account

pronouns'he/him/his' | 'she/her/hers' | 'they/them/their' | 'xe/xem/xyr'
kidsnumber
passportNumberstring
identityNumberstring

Identity Card Number

nationality'af' | 'ax' | 'al' | 'dz' | 'as' | 'ad' | 'ao' | 'ai' | 'aq' | 'ag' | 'ar' | 'am' | 'aw' | 'au' | 'at' | 'az' | 'bs' | 'bh' | 'bd' | 'bb' | 'by' | 'be' | 'bz' | 'bj' | 'bm' | 'bt' | 'bo' | 'bq' | 'ba' | 'bw' | 'bv' | 'br' | 'io' | 'bn' | 'bg' | 'bf' | 'bi' | 'kh' | 'cm' | 'ca' | 'cv' | 'ky' | 'cf' | 'td' | 'cl' | 'cn' | 'cx' | 'cc' | 'co' | 'km' | 'cg' | 'cd' | 'ck' | 'cr' | 'ci' | 'hr' | 'cu' | 'cw' | 'cy' | 'cz' | 'dk' | 'dj' | 'dm' | 'do' | 'ec' | 'eg' | 'sv' | 'gq' | 'er' | 'ee' | 'et' | 'fk' | 'fo' | 'fj' | 'fi' | 'fr' | 'gf' | 'pf' | 'tf' | 'ga' | 'gm' | 'ge' | 'de' | 'gh' | 'gi' | 'gr' | 'gl' | 'gd' | 'gp' | 'gu' | 'gt' | 'gg' | 'gn' | 'gw' | 'gy' | 'ht' | 'hm' | 'va' | 'hn' | 'hk' | 'hu' | 'is' | 'in' | 'id' | 'ir' | 'iq' | 'ie' | 'im' | 'il' | 'it' | 'jm' | 'jp' | 'je' | 'jo' | 'kz' | 'ke' | 'ki' | 'kp' | 'kr' | 'xk' | 'kw' | 'kg' | 'la' | 'lv' | 'lb' | 'ls' | 'lr' | 'ly' | 'li' | 'lt' | 'lu' | 'mo' | 'mk' | 'mg' | 'mw' | 'my' | 'mv' | 'ml' | 'mt' | 'mh' | 'mq' | 'mr' | 'mu' | 'yt' | 'mx' | 'fm' | 'md' | 'mc' | 'mn' | 'me' | 'ms' | 'ma' | 'mz' | 'mm' | 'na' | 'nr' | 'np' | 'nl' | 'an' | 'nc' | 'nz' | 'ni' | 'ne' | 'ng' | 'nu' | 'nf' | 'mp' | 'no' | 'om' | 'pk' | 'pw' | 'ps' | 'pa' | 'pg' | 'py' | 'pe' | 'ph' | 'pn' | 'pl' | 'pt' | 'pr' | 'qa' | 're' | 'ro' | 'ru' | 'rw' | 'bl' | 'sh' | 'kn' | 'lc' | 'mf' | 'pm' | 'vc' | 'ws' | 'sm' | 'st' | 'sa' | 'sn' | 'rs' | 'cs' | 'sc' | 'sl' | 'sg' | 'sx' | 'sk' | 'si' | 'sb' | 'so' | 'za' | 'gs' | 'ss' | 'es' | 'lk' | 'sd' | 'sr' | 'sj' | 'sz' | 'se' | 'ch' | 'sy' | 'tw' | 'tj' | 'tz' | 'th' | 'tl' | 'tg' | 'tk' | 'to' | 'tt' | 'tn' | 'tr' | 'tm' | 'tc' | 'tv' | 'ug' | 'ua' | 'ae' | 'gb' | 'us' | 'um' | 'uy' | 'uz' | 'vu' | 've' | 'vn' | 'vg' | 'vi' | 'wf' | 'eh' | 'ye' | 'zm' | 'zw'

Example request

{
  "address": {
    "street": "1000 5th Ave",
    "zipCode": "10028",
    "state": "New York",
    "city": "New York",
    "country": "United States",
    "countryCode": "US"
  },
  "otaLinks": [
    {
      "type": "airbnb",
      "url": "https://www.airbnb.com"
    }
  ]
}

Response

The guest has been successfully updated.

_idstring required
firstNamestring required
lastNamestring required
fullNamestring
hometownstring
createdAtstring date-time
addressobject
pictureobject

A link to guest’s picture in different sizes

emailstring

The main contact email of the guest

emailsstring[]

List of additional emails of the guest

phonestring

The main contact phone number

phonesstring[]

List of additional phone numbers of the guest

notesstring

Attention notes about the guest, describing important pieces of information about the guest, to review for all reservations (e.g. “Requires accessibility equipment”)

tagsstring[]

Tags for describing the guest at a glance + show the enum for the field to show the allowed options

goodToKnowNotesstring

“Good to know” notes about the guest. Notes to help capture facts about the guest that will help the team to personalize the guest’s stays (e.g. “Big football fan”)

preferredLanguagestring
birthdaystring date-time
genderstring
maritalStatusstring
dietaryPreferencesstring[]

You can pick one of the predefined options, or create a new one for your account

allergiesstring[]

You can pick one of the predefined options, or create a new one for your account

interestsstring[]
pronounsstring
kidsnumber
passportNumberstring
identityNumberstring
nationalitystring
contactTypestring
airbnb2object
rentalsUnitedobject
bookingComobject
homeAwayobject
tripAdvisorobject
policyobject
returningGuestboolean required

Example response

{
  "_id": "5e17287629e111001f7d3f4d",
  "firstName": "Rick",
  "lastName": "Sanchez",
  "fullName": "Rick Sanchez",
  "hometown": "New York",
  "createdAt": "2022-08-12T16:00:00.000+03:00",
  "address": {
    "street": "1000 5th Ave",
    "city": "New York",
    "country": "United States",
    "countryCode": "US",
    "zipCode": "10028",
    "state": "New York"
  },
  "picture": {
    "thumbnail": "//guestybookings.s3.amazonaws.com/guests/thumbnail_e2cb8a96-45a9-45cd-b28e-57e1ca1fc988.jpg",
    "large": "//guestybookings.s3.amazonaws.com/guests/large_e2cb8a96-45a9-45cd-b28e-57e1ca1fc988.jpg",
    "regular": "//guestybookings.s3.amazonaws.com/guests/regular_e2cb8a96-45a9-45cd-b28e-57e1ca1fc988.jpg"
  },
  "email": "email@email.com",
  "emails": [
    "email@email.com",
    "email2@email.com"
  ],
  "phone": "972234567454",
  "phones": [
    "972234567454",
    "972234567890"
  ],
  "notes": "This guest is rich",
  "tags": [
    "blocklisted",
    "VIP"
  ],
  "goodToKnowNotes": "This guest is alleric to peanuts",
  "birthday": "2017-08-12T16:00:00.000+03:00",
  "gender": "2017-08-12T16:00:00.000+03:00",
  "maritalStatus": "single",
  "dietaryPreferences": [
    "vegan",
    "veggies"
  ],
  "interests": [
    "sports"
  ],
  "pronouns": "he/him/his",
  "otaLinks": [
    {
      "type": "airbnb",
      "url": "https://www.airbnb.com"
    }
  ],
  "kids": 3,
  "passportNumber": "23424353",
  "identityNumber": "324325121",
  "nationality": "il",
  "contactType": "guest",
  "airbnb2": {
    "index": "index",
    "id": 4246064595217,
    "url": "https://www.airbnb.com",
    "firstName": "Rick"
  },
  "rentalsUnited": {
    "firstName": "Rick",
    "lastName": "Sanchez",
    "fullName": "Rick Sanchez",
    "failedPaymentMethod": "failed payment method"
  },
  "bookingCom": {
    "firstName": "Rick",
    "lastName": "Sanchez",
    "fullName": "Rick Sanchez",
    "url": "https://www.booking.com"
  },
  "homeAway": {
    "title": "title",
    "firstName": "Rick",
    "lastName": "Sanchez",
    "fullName": "Rick Sanchez",
    "url": "https://www.homeaway.com"
  },
  "tripAdvisor": {
    "title": "title",
    "firstName": "Rick",
    "lastName": "Sanchez",
    "fullName": "Rick Sanchez",
    "proxyEmail": "proxyemail@email.com",
    "url": "https://www.tripadvisor.com"
  },
  "policy": {
    "marketing": {
      "isAccepted": false,
      "dateOfAcceptance": null
    },
    "privacyObject": {
      "isAccepted": false,
      "dateOfAcceptance": null,
      "versionNumber": "ffewfewgw"
    }
  }
}