Create a guest

post https://api.zenoti.com/v1/guests

This API helps you to create a guest.

To create a new guest, you must fill the available details of the guest along with the mandatory fields that are set in the organization guest settings and then supply that guest object. In return, you will receive the guest object along with the unique identifier of the guest. Refer to the examples to know the minimum and maximum details required to create a guest.

Response Details

Name	Type	Description
center_id	guid	Unique 32-character identifier of the center.
personal_info	object	Object that contains the guest's personal information elements. For more information, refer to the personal_info Object table.
code	string	User code of the guest.
address_info	object	Object that contains the guest's address information elements. For more information, refer to the address_info Object table.
preferences	object	Object that contains the guest's preferences-related elements. For more information, refer to the preferences Object table.
tags	string	Any tags associated with the guest.
referral	object	Object that contains the guest's referral-related elements.
primary_employee	object	Object that contains the elements of the primary employee who created the guest.

personal_info Object

Name	Type	Description
user_name	string	User name of the guest.
first_name	string	First name of the guest.
last_name	string	Last name of the guest.
middle_name	string	Middle name of the guest.
email	string	Email ID of the guest.
mobile_phone	object	Object that contains the guest's mobile phone-related elements: `country_code` and `number`. Note: Here, `country_code` is the code of the country. For example, if you specify the `country_code` as 225 (for the United States of America), +1 will be updated in the UI as the United States of America's phone code. You can use the Retrieve the list of all countries API to fetch country codes (`id`) and each country's corresponding phone code (`phone_code`).
work_phone	object	Object that contains the guest's work phone-related elements: `country_code` and `number`. Note: Here, `country_code` is the code of the country. For example, if you specify the `country_code` as 225 (for the United States of America), +1 will be updated in the UI as the United States of America's phone code. You can use the Retrieve the list of all countries API to fetch country codes (`id`) and each country's corresponding phone code (`phone_code`).
home_phone	object	Object that contains the guest's work phone-related elements: `country_code` and `number`. Note: Here, `country_code` is the code of the country. For example, if you specify the `country_code` as 225 (for the United States of America), +1 will be updated in the UI as the United States of America's phone code. You can use the Retrieve the list of all countries API to fetch country codes (`id`) and each country's corresponding phone code (`phone_code`).
gender	enum	Indicates the gender of the guest Values: - NotSpecified (when no gender is specified) -1 - Male 1 - Female 0 - Other 3.
date_of_birth	datetime	Date of birth of the guest.
is_minor	boolean	Indicates whether the guest is a minor.
nationality_id	int	ID of the country to which the guest belongs. For example, the `nationality_id` of the United States of America is 225. You can use the Retrieve the list of all countries API to fetch country codes (`id`) and each country's corresponding phone code (`phone_code`).
anniversary_date	datetime	Anniversary date of the guest.
lock_guest_custom_data	boolean	Indicates whether the guest's custom data is to be locked.
pan	string	Permanent account number (PAN) details of the guest. Note: This parameter is valid only for guests from India.

address_info Object

Name	Type	Description
address_1	string	Primary address of the guest.
address_2	string	Secondary address of the guest.
city	string	City to which the guest belongs.
country_id	int	ID of the country to which the guest belongs. For example, the `country_id` of the United States of America is 225. You can use the Retrieve the list of all countries API to fetch country codes (`id`) and each country's corresponding phone code (`phone_code`).
state_id	int	ID of the state to which the guest belongs. For more information on how to fetch the state IDs of a specific country, refer to the Retrieve the list of all states of a country API.
state_other	string	Alternative state to which the guest belongs.
zip_code	string	Zip code of the guest's address.

preferences Object

Name	Type	Description
receive_transactional_email	boolean	Indicates whether the guest wants to receive transactional emails.
receive_transactional_sms	boolean	Indicates whether the guest wants to receive transactional SMSs.
receive_marketing_email	boolean	Indicates whether the guest wants to receive marketing emails.
receive_marketing_sms	boolean	Indicates whether the guest wants to receive marketing SMSs.
recieve_lp_stmt	boolean	Indicates whether the guest wants to receive loyalty points statements.
preferred_therapist	object	Object that contains the guest's preferred therapist details: `id` and `name`.
opt_in_for_loyalty_program	boolean	Indicates the status of the "Opt in to Loyalty Program" setting of the guest.

Language

Credentials

Header

Click Try It! to start a request and see the response here!