Skip to main content
POST
/
v1
/
organisations
Create organisation
curl --request POST \
  --url https://api.halth.com/v1/organisations \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "New Organisation",
  "members": [
    {
      "memberId": "New Organisation",
      "role": "owner"
    }
  ],
  "businesses": [
    {
      "name": "Super Health"
    }
  ],
  "brandImageUrl": "<string>"
}
'
{
  "id": "org_31XEcUshz1ymodA14HALnyP48g1",
  "name": "Acme Healthcare",
  "slug": "acme-healthcare",
  "createdAt": "2023-01-15T10:30:00Z",
  "bookingsEnabled": true,
  "brandImageUrl": "https://example.com/brand-image.png",
  "wordmarkImageUrl": "https://example.com/wordmark-image.png",
  "websiteUrl": "https://example.com"
}

Body

application/json
​
name
string
required

Name of the organisation

Example:

"New Organisation"

​
members
object[]
required

Members

Required array length: 1 - 100 elements
​
businesses
object[]
required
Required array length: 1 - 100 elements
​
brandImageUrl
string<uri>

Response

201 - application/json
​
id
string
required

Unique identifier for the organisation

Example:

"org_31XEcUshz1ymodA14HALnyP48g1"

​
name
string
required

Name of the organisation

Example:

"Acme Healthcare"

​
slug
string
required

URL-friendly identifier for the organisation

Example:

"acme-healthcare"

​
createdAt
string<date-time>
required

Date when the organisation was created

Example:

"2023-01-15T10:30:00Z"

​
bookingsEnabled
boolean
required

True if bookings are enabled for this organisation

Example:

true

​
brandImageUrl
string | null

URL to the organisation's brand image

Example:

"https://example.com/brand-image.png"

​
wordmarkImageUrl
string | null

URL to the organisation's wordmark image

Example:

"https://example.com/wordmark-image.png"

​
websiteUrl
string | null

URL to the organisation's website

Example:

"https://example.com"