Sign in

v2

latestOpenAPI 3.0.32026-08-07222102695.9 KB
Business

Create business

post/businesses

Request body

additional_informationstring nullable
additional_invoice_informationstring nullable
address_1string nullable
address_2string nullable
appointment_reminders_enabledboolean nullable
business_namestring nullable
business_registration_namestring nullable
business_registration_valuestring nullable
citystring nullable
contact_informationstring nullable
country_codestring nullable

ISO 3166-1 country code

display_namestring nullable
email_reply_tostring nullable
logostring

Base64 encoded file attachment

logo_heightinteger
post_codestring nullable
remove_logoboolean
show_in_online_bookingsboolean nullable
statestring nullable
time_zonestring nullable

See: supported time zones

time_zone_identifierstring nullable

See: supported time zone identifiers

website_addressstring nullable
appointment_type_idsstring[] nullable

Example request

{
  "country_code": "AU",
  "time_zone": "Melbourne",
  "time_zone_identifier": "Australia/Melbourne",
  "appointment_type_ids": [
    "1"
  ]
}

Response

Resource was created

additional_informationstring nullable
additional_invoice_informationstring nullable
address_1string nullable
address_2string nullable
appointment_reminders_enabledboolean nullable
appointment_type_idsstring[] nullable
archived_atstring date-time nullable
business_namestring nullable
business_registration_namestring nullable
business_registration_valuestring nullable
citystring nullable
contact_informationstring nullable
countrystring nullable
country_codestring nullable

ISO 3166-1 country code

created_atstring date-time
display_namestring nullable
email_reply_tostring nullable
idstring int64
labelstring nullable
post_codestring nullable
show_in_online_bookingsboolean nullable
statestring nullable
time_zonestring nullable

Human-readable label for a time zone. See link below for supported values.

time_zone_identifierstring nullable

IANA identifier for a time zone. See link below for supported values.

updated_atstring date-time
website_addressstring nullable

Example response

{
  "appointment_type_ids": [
    "1"
  ],
  "appointments": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/businesses/1/appointments"
    }
  },
  "country_code": "AU",
  "links": {
    "self": "https://api.au1.cliniko.com/v1/businesses/1"
  },
  "practitioners": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/businesses/1/practitioners"
    }
  },
  "time_zone": "Melbourne",
  "time_zone_identifier": "Australia/Melbourne"
}