v2

latestOpenAPI 3.0.32026-08-07222102695.9 KB

Appointment Type

Create appointment type

post/appointment_types

Request body

add_deposit_to_account_creditboolean nullable

billable_item_idstring int64

billable item id

categorystring nullable

colorstring

deposit_pricestring decimal nullable

descriptionstring nullable

duration_in_minutesinteger

online_bookings_lead_time_hours0 | 1 | 2 | 4 | 12 | 18 | 24 | 48 | 72 | 168 | 336 | 504 | 672 nullable

online_payments_mode'deposit_required' | 'optional' | 'required' nullable

max_attendeesinteger

namestring

product_idstring int64

product id

show_in_online_bookingsboolean nullable

telehealth_enabledboolean nullable

treatment_note_template_idstring int64

treatment note template id

appointment_confirmation_template_idsstring[] nullable

appointment_follow_up_template_idsstring[] nullable

appointment_reminder_template_idsstring[] nullable

business_idsstring[]

practitioner_idsstring[]

Practitioner ids

Example request

{
  "billable_item_id": "1",
  "product_id": "1",
  "treatment_note_template_id": "1",
  "appointment_confirmation_template_ids": [
    "1"
  ],
  "appointment_follow_up_template_ids": [
    "1"
  ],
  "appointment_reminder_template_ids": [
    "1"
  ],
  "business_ids": [
    "1"
  ],
  "practitioner_ids": [
    "1"
  ]
}

Response

Resource was created

add_deposit_to_account_creditboolean nullable

appointment_confirmation_template_idsstring[] nullable

appointment_follow_up_template_idsstring[] nullable

appointment_reminder_template_idsstring[] nullable

archived_atstring date-time nullable

categorystring nullable

colorstring

created_atstring date-time

deposit_pricestring decimal nullable

descriptionstring nullable

duration_in_minutesinteger

idstring int64

max_attendeesinteger

namestring

online_bookings_lead_time_hours0 | 1 | 2 | 4 | 12 | 18 | 24 | 48 | 72 | 168 | 336 | 504 | 672 nullable

online_payments_enabledboolean nullable

online_payments_mode'deposit_required' | 'optional' | 'required' nullable

show_in_online_bookingsboolean nullable

telehealth_enabledboolean nullable

updated_atstring date-time

Example response

{
  "appointment_confirmation_template_ids": [
    "1"
  ],
  "appointment_follow_up_template_ids": [
    "1"
  ],
  "appointment_reminder_template_ids": [
    "1"
  ],
  "appointment_type_billable_items": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/appointment_type_billable_items?q%5B%5D=appointment_type_id%3A%3D1"
    }
  },
  "appointment_type_products": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/appointment_type_products?q%5B%5D=appointment_type_id%3A%3D1"
    }
  },
  "billable_item": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/billable_items/1"
    }
  },
  "links": {
    "self": "https://api.au1.cliniko.com/v1/appointment_types/1"
  },
  "practitioners": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/appointment_types/1/practitioners"
    }
  },
  "product": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/products/1"
    }
  },
  "treatment_note_template": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/treatment_note_templates/1"
    }
  }
}