Sign in

v2

latestOpenAPI 3.0.32026-08-07222102695.9 KB
Patient

Unarchive patient

post/patients/{id}/unarchive

Path parameters

idstring int64 required

Response

Resource was unarchived

accepted_email_marketingboolean nullable
accepted_privacy_policyboolean nullable
accepted_sms_marketingboolean nullable
address_1string nullable
address_2string nullable
address_3string nullable
appointment_notesstring nullable
archived_atstring date-time nullable
citystring nullable
countrystring nullable
country_codestring nullable

ISO 3166-1 country code

created_atstring date-time
date_of_birthstring date nullable
deleted_atstring date-time nullable
dva_card_numberstring nullable
emailstring nullable
emergency_contactstring nullable
first_namestring
follow_ups_communication_channelsinteger[]

Channels through which the patient will receive appointment follow-up messages.

Enum ValueDescription
1SMS
2Email
follow_ups_communication_channels_description'None' | 'SMS' | 'Email' | 'SMS & Email'
genderstring nullable
gender_identitystring nullable
idstring int64
invoice_default_tostring nullable
invoice_emailstring nullable
invoice_extra_informationstring nullable
labelstring nullable

Full name

last_namestring
medicarestring nullable
medicare_reference_numberstring nullable
merged_atstring date-time nullable
notesstring nullable
occupationstring nullable
old_reference_idstring nullable
post_codestring nullable
preferred_first_namestring nullable
receives_cancellation_emailsboolean nullable
receives_confirmation_emailsboolean
referral_sourcestring nullable
reminder_type'None' | 'SMS' | 'Email' | 'SMS & Email' nullable

Please use the reminders_communication_channels attribute instead.

reminders_communication_channelsinteger[]

Channels through which the patient will receive appointment reminders.

Enum ValueDescription
1SMS
2Email
reminders_communication_channels_description'None' | 'SMS' | 'Email' | 'SMS & Email'
sexstring nullable
statestring nullable
time_zonestring nullable

See: supported time zone identifiers

titlestring nullable
updated_atstring date-time

Example response

{
  "appointments": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/patients/1/appointments"
    }
  },
  "attendees": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/attendees?q%5B%5D=patient_id%3A%3D1"
    }
  },
  "concession_type": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/concession_types/1"
    }
  },
  "country_code": "AU",
  "custom_fields": {
    "sections": [
      {
        "token": "ef4c43ec-105d-489c-88cc-0f3c5f67dc70",
        "fields": [
          {
            "token": "ef4c43ec-105d-489c-88cc-0f3c5f67dc70"
          }
        ]
      }
    ]
  },
  "follow_ups_communication_channels": [
    1,
    2
  ],
  "invoices": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/patients/1/invoices"
    }
  },
  "latest_booking": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/bookings/1"
    }
  },
  "links": {
    "self": "https://api.au1.cliniko.com/v1/patients/1"
  },
  "medical_alerts": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/patients/1/medical_alerts"
    }
  },
  "merged_with_patient": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/patients/1"
    }
  },
  "patient_attachments": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/patients/1/patient_attachments"
    }
  },
  "patient_phone_numbers": [
    {
      "normalized_number": "39012345678",
      "number": "0-123-456-78"
    }
  ],
  "referring_doctor": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/contacts/1"
    }
  },
  "relationships": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/relationships?q%5B%5D=patient_id%3A%3D1"
    }
  },
  "reminders_communication_channels": [
    1,
    2
  ],
  "time_zone": "Australia/Melbourne"
}