Update details of a guest

PUT https://api.zenoti.com/v1/guests/{guest_id}

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.


On this page


Before you begin

Permission: Manage API Keys (on the Administrator security object) — Required to access Zenoti APIs.

Endpoint

PUT /v1/guests/{guest_id}

Base URL: https://api.zenoti.com

Request

Headers

Header Required Description
Authorization Yes bearer {{access_token}}

Path parameters

Parameter Type Required Description
guest_id string Yes Unique identifier of the guest.

Query parameters

Parameter Type Required Default Description
tags string Yes — Mandatory Any tags associated with the guest.
address_info object Yes — Mandatory Object that contains the guest's address information elements. For more information, refer to the address_info Object table.
preferences object Yes — Mandatory Object that contains the guest's preferences-related elements. For more information, refer to the preferences Object table.
referral object Yes — Mandatory Object that contains the guest's referral-related elements.
primary_employee object Yes — Mandatory Object that contains the elements of the primary employee who created the guest.

Request body

Field Type Required Description
id string No A unique identifier of the guest
code string Yes Mandatory User code of the guest.
center_id string Yes Mandatory Unique 32-character identifier of the center.
center_name string No Name of the center to which the guest belongs.
personal_info object Yes Mandatory Object that contains the guest's personal information elements.
preferred_service_id string No Preferred service id for the guest.
created_date string (date) No Date when the guest is created.
can_edit_personal_info boolean No Denotes if the personal info of the guest is editable. True: Can edit. False: Cannot edit.
is_virtual_guest boolean No Denotes if the guest is virtual (for Classes and Workshops). True: Guest is virtual. False: Guest is not virtual.
guest_type string No Unique Identifier - Denotes the type of guest.
is_guest_custom_form_filled boolean No Denote if the guest's custom form is filled.
login_info object No Object containing the details of the guest login
expand string[] No (optional) Values considered for listing in response object - address_info, preferences, email_details, primary_employee, referral, tags.

Response

Success (200 OK)

{
  "id": "4261fadb-f00c-4d3d-a9c4-898cbfc221dc",
  "code": "",
  "center_id": "b5ed4fbb-4c05-4195-b313-1320b620224b",
  "personal_info": {
    "user_name": "simonsimu",
    "first_name": "simon",
    "last_name": "simon",
    "middle_name": "simon",
    "email": "simon@simon.com",
    "mobile_phone": {
      "...": "..."
    },
    "work_phone": {
      "...": "..."
    },
    "home_phone": {
      "...": "..."
    },
    "gender": 1,
    "date_of_birth": "1997-08-02T00:00:00",
    "is_minor": false,
    "nationality_id": 95,
    "anniversary_date": "2018-11-06T00:00:00",
    "lock_guest_custom_data": false,
    "pan": ""
  },
  "address_info": {
    "address_1": "aaaaaaaaa",
    "address_2": "bbbbbbbbb",
    "city": "cccccccccc",
    "country_id": 95,
    "state_id": -2,
    "state_other": "mystate",
    "zip_code": "502032"
  },
  "preferences": {
    "receive_transactional_email": true,
    "receive_transactional_sms": true,
    "receive_marketing_email": true,
    "receive_marketing_sms": true,
    "recieve_lp_stmt": true,
    "preferred_therapist": {
      "...": "..."
    }
  },
  "tags": [
    "CHECKED_IN"
  ],
  "referral": {
    "referral_source": {
      "...": "..."
    },
    "referred_by": {
      "...": "..."
    }
  },
  "primary_employee": {
    "id": "4a98db4c-8424-466e-97f8-2e54d529fdbd",
    "name": "New Delhi_mgr mgr"
  }
}

Response fields

Field Type Description
id string
code string
center_id string
personal_info object
personal_info.user_name string
personal_info.first_name string
personal_info.last_name string
personal_info.middle_name string
personal_info.email string
personal_info.mobile_phone object
personal_info.work_phone object
personal_info.home_phone object
personal_info.gender integer
personal_info.date_of_birth string
personal_info.is_minor boolean
personal_info.nationality_id integer
personal_info.anniversary_date string
personal_info.lock_guest_custom_data boolean
personal_info.pan string
address_info object
address_info.address_1 string
address_info.address_2 string
address_info.city string
address_info.country_id integer
address_info.state_id integer
address_info.state_other string
address_info.zip_code string
preferences object
preferences.receive_transactional_email boolean
preferences.receive_transactional_sms boolean
preferences.receive_marketing_email boolean
preferences.receive_marketing_sms boolean
preferences.recieve_lp_stmt boolean
preferences.preferred_therapist object
tags string[]
referral object
referral.referral_source object
referral.referred_by object
primary_employee object
primary_employee.id string
primary_employee.name string

Example

curl --request PUT \
  --url 'https://api.zenoti.com/v1/guests/{guest_id}?tags={{tags}}&address_info={{address_info}}&preferences={{preferences}}&referral={{referral}}&primary_employee={{primary_employee}}' \
  --header 'Authorization: bearer {{access_token}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "string",
  "code": "string",
  "center_id": "string",
  "center_name": "string",
  "personal_info": {
    "user_name": "string",
    "first_name": "string",
    "last_name": "string",
    "middle_name": "string",
    "email": "string",
    "mobile_phone": {
      "...": "..."
    },
    "country_code": "string",
    "number": "string"
  },
  "preferred_service_id": "string",
  "created_date": "2026-01-15",
  "can_edit_personal_info": true,
  "is_virtual_guest": true,
  "guest_type": "string",
  "is_guest_custom_form_filled": true,
  "login_info": {
    "password": "string"
  },
  "expand": [
    "string"
  ]
}'
const response = await fetch('https://api.zenoti.com/v1/guests/{guest_id}', {
  method: 'PUT',
  headers: {
    'Authorization': 'bearer {{access_token}}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  id: 'string',
  code: 'string',
  center_id: 'string',
  center_name: 'string',
  personal_info: {
    user_name: 'string',
    first_name: 'string',
    last_name: 'string',
    middle_name: 'string',
    email: 'string',
    mobile_phone: { '...': '...' },
    country_code: 'string',
    number: 'string'
  },
  preferred_service_id: 'string',
  created_date: '2026-01-15',
  can_edit_personal_info: true,
  is_virtual_guest: true,
  guest_type: 'string',
  is_guest_custom_form_filled: true,
  login_info: { password: 'string' },
  expand: [
    'string'
  ]
})
});
const data = await response.json();
import requests

response = requests.put(
    'https://api.zenoti.com/v1/guests/{guest_id}',
    headers={
        'Authorization': 'bearer {{access_token}}',
    },
    json={'id': 'string', 'code': 'string', 'center_id': 'string', 'center_name': 'string', 'personal_info': {'user_name': 'string', 'first_name': 'string', 'last_name': 'string', 'middle_name': 'string', 'email': 'string', 'mobile_phone': {'...': '...'}, 'country_code': 'string', 'number': 'string'}, 'preferred_service_id': 'string', 'created_date': '2026-01-15', 'can_edit_personal_info': True, 'is_virtual_guest': True, 'guest_type': 'string', 'is_guest_custom_form_filled': True, 'login_info': {'password': 'string'}, 'expand': ['string']}
)
data = response.json()
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "bearer {{access_token}}");
var content = new StringContent(
    JsonSerializer.Serialize(new {
    id = "string",
    code = "string",
    center_id = "string",
    center_name = "string",
    personal_info = new {
        user_name = "string",
        first_name = "string",
        last_name = "string",
        middle_name = "string",
        email = "string",
        mobile_phone = new { ... = "..." },
        country_code = "string",
        number = "string"
    },
    preferred_service_id = "string",
    created_date = "2026-01-15",
    can_edit_personal_info = true,
    is_virtual_guest = true,
    guest_type = "string",
    is_guest_custom_form_filled = true,
    login_info = new { password = "string" },
    expand = new[] {
        "string"
    }
}),
    Encoding.UTF8, "application/json");
var response = await client.PutAsync(
    "https://api.zenoti.com/v1/guests/{guest_id}", content);
var data = await response.Content.ReadAsStringAsync();
require 'net/http'
require 'json'

uri = URI('https://api.zenoti.com/v1/guests/{guest_id}')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Put.new(uri)
request['Authorization'] = 'bearer {{access_token}}'
request['Content-Type'] = 'application/json'
request.body = { id: 'string', code: 'string', center_id: 'string', center_name: 'string', personal_info: { user_name: 'string', first_name: 'string', last_name: 'string', middle_name: 'string', email: 'string', mobile_phone: { ...: '...' }, country_code: 'string', number: 'string' }, preferred_service_id: 'string', created_date: '2026-01-15', can_edit_personal_info: true, is_virtual_guest: true, guest_type: 'string', is_guest_custom_form_filled: true, login_info: { password: 'string' }, expand: ['string'] }.to_json
response = http.request(request)
data = JSON.parse(response.body)

Error codes

Status Description
400 400
401 Unauthorized -- invalid or expired access token
429 Too many requests -- rate limit exceeded