Update a client

patch

https://api.rehabguru.com/api/v1/clients/{id}

Update an existing client and their details. All fields are optional — only provided fields will be updated. To clear a field, set it to null.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The unique client object ID.

Body Params

Input schema for creating or updating a client. All fields except name (required for create) are optional.

name

string

required

length between 1 and 200

Client full name (required for create).

string | null

Client email address.

clientPin

string | null

PIN for client portal access.

sourceId

string | null

External system identifier.

source

string | null

Name of the external source system (e.g. Cliniko).

title

string | null

Title (Mr, Ms, Dr, etc.).

pronouns

string | null

Preferred pronouns.

phoneNumber

object | null

Phone number with country code.

preferredName

string | null

Preferred/nickname.

dateOfBirth

date | null

Date of birth (ISO 8601).

sex

string | null

Biological sex.

address

string | null

Street address.

postCode

string | null

Postal / ZIP code.

country

string | null

Country code.

occupation

string | null

Client occupation.

allergies

string | null

Known allergies.

medication

string | null

Current medication.

pastMedicalHistory

string | null

Relevant past medical history.

doctorsName

string | null

Doctor's name.

doctorsAddress

string | null

Doctor's address.

doctorsPostcode

string | null

Doctor's postcode.

emergencyContactName

string | null

Emergency contact name.

emergencyContactNumber

object | null

Emergency contact phone number.

extraInformation

string | null

Additional notes or information.

smsReminder

boolean | null

SMS appointment reminders enabled.

smsMarketing

boolean | null

SMS marketing enabled.

emailReminder

boolean | null

Email appointment reminders enabled.

emailMarketing

boolean | null

Email marketing enabled.

Responses

Language

Credentials

Bearer

API Key

Loading…

Response

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

application/json

200Client updated successfully.

400Invalid request — validation failed or missing required fields.

401Authentication failed — missing or invalid API key.

404The requested resource was not found.

500An unexpected error occurred on the server.