Create guest

post

https://open-api.guesty.com/v1/guests-crud

Create guest

Body Params

firstName

string

required

lastName

string

required

hometown

string

address

object

picture

object

A link to guest’s picture in different sizes

string

The main contact email of the guest

emails

array of strings

List of additional emails of the guest

emails

phone

string

The main contact phone number

phones

array of strings

List of additional phone numbers of the guest

phones

notes

string

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.

contactType

string

enum

Allowed:

tags

goodToKnowNotes

string

“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

string

enum

birthday

date-time

gender

string

enum

Allowed:

maritalStatus

string

enum

Allowed:

dietaryPreferences

array of strings

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

dietaryPreferences

allergies

array of strings

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

allergies

interests

array of strings

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

interests

pronouns

string

enum

Allowed:

kids

number

≥ 0

passportNumber

string

length ≤ 50

identityNumber

string

length ≤ 50

Identity Card Number

nationality

string

enum

otaLinks

array of objects

A link to the guest’s profile on an OTA

otaLinks

Responses

201

401

Can not create guest, unauthorized

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The guest has been successfully created.