Skip to main content
POST
Create client

Path Parameters

organisationId
string
required

Body

application/json
firstName
string

The first name of the client

Example:

"John"

lastName
string

The last name of the client

Example:

"Doe"

mobileNumber
string<mobile-phone>

The mobile number of the client

Example:

"+27712345678"

email
string<email>

The email address of the client

Example:

"john.doe@example.com"

dateOfBirth
string

The date of birth of the client

Example:

"1990-01-01"

Response

201 - application/json
id
string
required
deleted
boolean
required
createdAt
string<date-time>
required
memberId
string

The ID of the member if the client has joined HaltH

Example:

"memb_38JiySr0Z0ePjHpqvosimyLQuUC"

firstName
string
lastName
string
dateOfBirth
string
mobileNumber
string
email
string
source
enum<string>
Available options:
pms,
halth,
unknown
pmsPatientId
string
pmsCreatedAt
string<date-time>
profileImageUrl
string