Skip to main content
POST
/
v1
/
businesses
Create business
curl --request POST \
  --url https://api.halth.com/v1/businesses \
  --header 'Content-Type: application/json' \
  --header 'x-halth-organisation-id: <x-halth-organisation-id>' \
  --data '
{
  "name": "Super Health"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "settings": {
    "autoReconciliationEnabled": true
  },
  "taxIdentifier": "<string>",
  "countryCode": "<string>",
  "structure": "public_corporation",
  "merchantId": "<string>",
  "capabilities": [
    {
      "id": "bookings_client_management",
      "status": "inactive"
    }
  ]
}

Headers

​
x-halth-organisation-id
string
required

Body

application/json
​
name
string
required

Business name

Required string length: 1 - 255
Example:

"Super Health"

Response

201 - application/json
​
id
string
required
​
name
string
required
​
settings
object
required
​
taxIdentifier
string
​
countryCode
string
​
structure
enum<string>
Available options:
public_corporation,
private_corporation,
sole_proprietorship,
private_partnership,
trust,
incorporated_non_profit,
unincorporated_association
​
merchantId
string
​
capabilities
object[]