Update client

put

https://{apiHost}/api/v2/public/clients/{clientId}

Update an existing client record. Only provided fields will be updated.
To change client status, use the timeline endpoint instead.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

clientId

string

required

Unique client identifier

Body Params

Client input for create/update operations

firstName

string

Client's first name

lastName

string

Client's last name

phoneNumber

string

Primary phone number (will be normalized to digits only)

string

Email address (will be normalized to lowercase)

dateOfBirth

date

Date of birth (YYYY-MM-DD)

gender

string

enum

Gender (only 'male' or 'female' accepted)

Allowed:

address

object

Standard address format used across the API (matches internal manualAddressSchema)

locationId

string

Geographic location ID

status

string

enum

Client status

medicalRecordNumber

string

Medical Record Number (MRN)

externalId

string

External system identifier

Responses

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Client updated successfully

400Request validation failed

401Authentication failed - invalid or missing API key

403Access denied - insufficient permissions or scope

404Resource not found

429Rate limit exceeded