Sign in

v2

latestOpenAPI 3.0.32026-08-07222102695.9 KB
Individual Appointment

Update individual appointment

patch/individual_appointments/{id}

Path parameters

idstring int64 required

Request body

appointment_type_idstring int64

appointment type id

business_idstring int64

business id

ends_atstring date-time

If not provided on create or set to null on update, this will be based on the duration of the appointment type.

notesstring nullable
patient_idstring int64

patient id

patient_case_idstring int64

patient case id

practitioner_idstring int64

practitioner id

starts_atstring date-time

Example request

{
  "appointment_type_id": "1",
  "business_id": "1",
  "patient_id": "1",
  "patient_case_id": "1",
  "practitioner_id": "1"
}

Response

Resource was updated

archived_atstring date-time nullable
booking_ip_addressstring ipv4 nullable
cancellation_notestring nullable
cancellation_reasoninteger nullable
cancellation_reason_description'Feeling Better' | 'Condition Worse' | 'Sick' | 'COVID-19 related' | 'Away' | 'Other' | 'Work' nullable
cancelled_atstring date-time nullable
created_atstring date-time
deleted_atstring date-time nullable
did_not_arriveboolean nullable
email_reminder_sentboolean nullable
ends_atstring date-time
has_patient_appointment_notesboolean nullable
idstring int64
invoice_statusinteger nullable
notesstring nullable
online_booking_policy_acceptedboolean nullable
patient_arrivedboolean nullable
patient_namestring nullable
sms_reminder_sentboolean nullable
starts_atstring date-time
telehealth_urlstring uri nullable
treatment_note_statusinteger nullable
updated_atstring date-time

Example response

{
  "appointment_type": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/appointment_types/1"
    }
  },
  "attendees": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/individual_appointments/1/attendees"
    }
  },
  "booking_ip_address": "10.0.0.43",
  "business": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/businesses/1"
    }
  },
  "conflicts": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/individual_appointments/1/conflicts"
    }
  },
  "links": {
    "self": "https://api.au1.cliniko.com/v1/individual_appointments/1"
  },
  "patient": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/patients/1"
    }
  },
  "patient_case": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/patient_cases/1"
    }
  },
  "practitioner": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/practitioners/1"
    }
  },
  "repeated_from": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/individual_appointments/1"
    }
  },
  "repeats": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/individual_appointments?q[]=repeated_from_id:=1"
    }
  }
}