v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Update details of a guest

Use this API to update the details of a guest. To update the details of a guest, modify the expanded guest object and supply it to this API. In return, you will receive the modified guest object. Note: You must send all the fields obtained from the Retrieve guest details API, even if you want to change the details of only one field. This API also allows guests to update another guest details provided they have a relationship defined in Zenoti. Also, only a host guest token can make changes to another guest.

put/v1/guests/{guest_id}

Path parameters

guest_idstring required

Unique identifier of the guest.

Query parameters

tagsstring required

Mandatory Any tags associated with the guest.

address_infoobject required

Mandatory Object that contains the guest's address information elements. For more information, refer to the address_info Object table.

preferencesobject required

Mandatory Object that contains the guest's preferences-related elements. For more information, refer to the preferences Object table.

referralobject required

Mandatory Object that contains the guest's referral-related elements.

primary_employeeobject required

Mandatory Object that contains the elements of the primary employee who created the guest.

Request body

idstring

A unique identifier of the guest

codestring required

Mandatory User code of the guest.

center_idstring required

Mandatory Unique 32-character identifier of the center.

center_namestring

Name of the center to which the guest belongs.

preferred_service_idstring

Preferred service id for the guest.

created_datestring date

Date when the guest is created.

can_edit_personal_infoboolean

Denotes if the personal info of the guest is editable. True: Can edit. False: Cannot edit.

is_virtual_guestboolean

Denotes if the guest is virtual (for Classes and Workshops). True: Guest is virtual. False: Guest is not virtual.

guest_typestring

Unique Identifier - Denotes the type of guest.

is_guest_custom_form_filledboolean

Denote if the guest's custom form is filled.

expandstring[]

(optional) Values considered for listing in response object - address_info, preferences, email_details, primary_employee, referral, tags.

tin_numberstring

Tax Identification Number (GSTIN) associated with the guest or organization.

registration_typeinteger

Registration type associated with the GST registration.

registration_idstring

Registration identifier associated with the GST registration.

account_namestring

Account or organization name associated with the GST registration.

legal_namestring

Legal name of the organization associated with the GST registration.

Response

200