Skip to main content
PATCH
/
clients
/
{id}
curl -X PATCH "https://api.wizlo.example.com/clients/acf919e9-4661-444f-8496-afb07e731a6f" \
  -H "Authorization: Bearer <your_access_token>" \
  -H "Content-Type: application/json" \
  -d '{
  "address": "4751 Amberwood Drive",
  "cityId": "01a2fbd2-bd67-4cd1-a297-080f486c314d",
  "postalCode": "45424",
  "notes": "Updated address details."
}'

{
  "user_id": "3d8ee312-1697-43c5-a63e-015e9c0db749",
  "firstName": "John",
  "lastName": "Patient",
  "dateOfBirth": "1985-06-15T00:00:00.000Z",
  "sex": "male",
  "phone": "6463862217",
  "email": "johnwickelliemd@yopmail.com",
  "address1": "4751 Amberwood Drive",
  "address2": null,
  "cityId": "01a2fbd2-bd67-4cd1-a297-080f486c314d",
  "stateId": "01a2fbd2-bd67-4cd1-a297-080f486c314a",
  "countryId": "01a2fbd2-bd67-4cd1-a297-080c486c314a",
  "postal": "45424",
  "timezone": null,
  "locale": null,
  "metadata": null,
  "createdAt": "2025-11-21T12:10:08.028Z",
  "updatedAt": "2025-11-27T09:03:59.993Z",
  "notes": "Updated address details.",
  "emergencyContact": null,
  "emergencyContactCode": null,
  "emergencyContactName": null,
  "employer": "Justice League International",
  "workMobile": null,
  "gfeStateId": null,
  "profileImageBlobPath": null,
  "maritalStatus": null,
  "isHomeAddressSameAsShipping": true,
  "vouchedJobId": null,
  "isVerified": "NOTVERIFIED",
  "vouchedInviteSentDate": null,
  "vouchedReminderCount": 0,
  "vouchedResultMessage": null,
  "vouchedResponsePayload": null,
  "acsUserId": null
}

​
Overview

This endpoint allows authorized staff or external systems to update specific details of an existing patient profile. Behavior:
  • Identification: The patient is identified by the id (UUID) provided in the URL path.
  • Partial Update: Only the fields provided in the request body will be updated. Fields omitted from the request will remain unchanged.
  • Validation: Email addresses must remain unique within the tenant if updated.

​
Headers

This endpoint uses Machine-to-Machine (M2M) authentication.
​
Authorization
string
required
Standard Bearer token (e.g., Bearer <your_access_token>). See the M2M Authentication guide for details on generating this token.
​
Content-Type
string
required
Must be set to application/json.

​
Path Parameters

​
id
string
required
The unique UUID of the patient (client) to update.

​
Body Parameters

All fields are optional. Provide only the fields you wish to update.
​
firstName
string
The patient’s first name.
​
lastName
string
The patient’s last name.
​
email
string
The patient’s email address. Must be unique.
​
dateOfBirth
string
The patient’s date of birth in YYYY-MM-DD format.
​
countryCode
string
The country dialing code for the phone number (e.g., “+1”).
​
phone
string
The patient’s primary phone number (digits only).
​
gender
string
The patient’s gender (e.g., “male”, “female”, “other”).
​
address
string
Primary street address (Line 1).
​
address2
string
Secondary address information (Line 2, Apt/Suite).
​
postalCode
string
Zip or Postal code.
​
cityId
string
UUID of the city.
​
stateId
string
UUID of the state.
​
countryId
string
UUID of the country.
​
gfeStateId
string
UUID of the state relevant for the Good Faith Estimate (GFE).
​
notes
string
General notes regarding the patient.
​
emergencyContact
string
Phone number for the emergency contact.
​
emergencyContactName
string
Full name of the emergency contact.
​
employer
string
Name of the patient’s employer.
​
workMobile
string
Work phone number.
​
maritalStatus
string
Marital status (e.g., “single”, “married”, “divorced”).
​
isHomeAddressSameAsShipping
boolean
Flag indicating if the shipping address matches the home address.
​
insuranceInfo
string
Free text field for insurance details.
​
medicalHistory
string
Free text field for medical history.

​
Response Parameters

The response is the full Patient (UserDetails) object.
​
user_id
string
The unique UUID of the patient.
​
firstName
string
Patient First Name.
​
email
string
Patient Email.
​
isVerified
string
Identity verification status (e.g., “NOTVERIFIED”, “VERIFIED”).
​
metadata
object
Additional dynamic metadata.

​
Status Codes

StatusDescription
200OK. The patient profile was successfully updated.
400Bad Request. Invalid fields or format.
401Unauthorized. Invalid or missing authentication token.
404Not Found. The patient with the specified id does not exist.
409Conflict. The provided email is already in use by another patient.
curl -X PATCH "https://api.wizlo.example.com/clients/acf919e9-4661-444f-8496-afb07e731a6f" \
  -H "Authorization: Bearer <your_access_token>" \
  -H "Content-Type: application/json" \
  -d '{
  "address": "4751 Amberwood Drive",
  "cityId": "01a2fbd2-bd67-4cd1-a297-080f486c314d",
  "postalCode": "45424",
  "notes": "Updated address details."
}'

{
  "user_id": "3d8ee312-1697-43c5-a63e-015e9c0db749",
  "firstName": "John",
  "lastName": "Patient",
  "dateOfBirth": "1985-06-15T00:00:00.000Z",
  "sex": "male",
  "phone": "6463862217",
  "email": "johnwickelliemd@yopmail.com",
  "address1": "4751 Amberwood Drive",
  "address2": null,
  "cityId": "01a2fbd2-bd67-4cd1-a297-080f486c314d",
  "stateId": "01a2fbd2-bd67-4cd1-a297-080f486c314a",
  "countryId": "01a2fbd2-bd67-4cd1-a297-080c486c314a",
  "postal": "45424",
  "timezone": null,
  "locale": null,
  "metadata": null,
  "createdAt": "2025-11-21T12:10:08.028Z",
  "updatedAt": "2025-11-27T09:03:59.993Z",
  "notes": "Updated address details.",
  "emergencyContact": null,
  "emergencyContactCode": null,
  "emergencyContactName": null,
  "employer": "Justice League International",
  "workMobile": null,
  "gfeStateId": null,
  "profileImageBlobPath": null,
  "maritalStatus": null,
  "isHomeAddressSameAsShipping": true,
  "vouchedJobId": null,
  "isVerified": "NOTVERIFIED",
  "vouchedInviteSentDate": null,
  "vouchedReminderCount": 0,
  "vouchedResultMessage": null,
  "vouchedResponsePayload": null,
  "acsUserId": null
}