API Reference
  1. Rehab Guru Public API (Beta)
  2. Clients

Create a new client

post
https://api.rehabguru.com/api/v1/clients

Create a new client with details. The name field is required. All other fields are optional and can be set on the client or in the nested details object.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

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

string
required
length between 1 and 200

Client full name (required for create).

string | null

Client email address.

string | null

PIN for client portal access.

string | null

External system identifier.

string | null

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

string | null

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

string | null

Preferred pronouns.

phoneNumber
object | null

Phone number with country code.

string | null

Preferred/nickname.

date | null

Date of birth (ISO 8601).

string | null

Biological sex.

string | null

Street address.

string | null

Postal / ZIP code.

string | null

Country code.

string | null

Client occupation.

string | null

Known allergies.

string | null

Current medication.

string | null

Relevant past medical history.

string | null

Doctor's name.

string | null

Doctor's address.

string | null

Doctor's postcode.

string | null

Emergency contact name.

emergencyContactNumber
object | null

Emergency contact phone number.

string | null

Additional notes or information.

boolean | null

SMS appointment reminders enabled.

boolean | null

SMS marketing enabled.

boolean | null

Email appointment reminders enabled.

boolean | null

Email marketing enabled.

Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
Bearer
API Key
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?