Skip to main content
POST
/
v1
/
businesses
/
{businessId}
/
client-invites
Invite a client to a business
curl --request POST \
  --url https://api.halth.com/v1/businesses/{businessId}/client-invites \
  --header 'Content-Type: application/json' \
  --data '
{
  "clientId": "1",
  "mobileNumber": "+61400000000",
  "email": "milo@halth.com",
  "name": "Milo"
}
'

Path Parameters

​
businessId
string
required

Body

application/json
​
clientId
string

The ID of the client

Example:

"1"

​
mobileNumber
string<mobile-phone>

The mobile number of the client

Example:

"+61400000000"

​
email
string<email>

The email address of the client

Example:

"milo@halth.com"

​
name
string

The first name of the client to include in communications

Example:

"Milo"

Response

201 - undefined