Skip to main content
PATCH
/
v1
/
organisations
/
{organisationId}
/
clients
/
{clientId}
Update client
curl --request PATCH \
  --url https://api.halth.com/v1/organisations/{organisationId}/clients/{clientId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "mobileNumber": "+27712345678"
}
'
{
  "id": "<string>",
  "deleted": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "memberId": "memb_38JiySr0Z0ePjHpqvosimyLQuUC",
  "firstName": "<string>",
  "lastName": "<string>",
  "dateOfBirth": "<string>",
  "mobileNumber": "<string>",
  "email": "<string>",
  "source": "pms",
  "pmsPatientId": "<string>",
  "pmsCreatedAt": "2023-11-07T05:31:56Z",
  "profileImageUrl": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.halth.com/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

​
organisationId
string
required
​
clientId
string
required

Body

application/json
​
mobileNumber
string<mobile-phone>

The mobile number of the client

Example:

"+27712345678"

Response

200 - 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