API Reference

Create guest

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

Create guest

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
string
required
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
string

The main contact phone number

phones
array of strings

List of additional phone numbers of the guest

phones
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.

string
enum
Allowed:
tags
array of strings

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

tags
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”)

string
enum
date-time
string
enum
Allowed:
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
string
enum
Allowed:
number
≥ 0
string
length ≤ 50
string
length ≤ 50

Identity Card Number

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

Updated 5 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 days ago