v2

latestOpenAPI 3.0.32026-08-07222102695.9 KB
Relationship

Update relationship

patch/relationships/{id}

Path parameters

idstring int64 required

Request body

patient_idstring int64

patient id

related_patient_idstring int64

patient id

relation10 | 20 | 30 | 40 | 50 | 60 | 70
Enum ValueDescription
10Parent
20Child
30Sibling
40Spouse
50Partner
60Relative
70Other

Example request

{
  "patient_id": "1",
  "related_patient_id": "1"
}

Response

Resource was updated

archived_atstring date-time nullable
created_atstring date-time
idstring int64
relation10 | 20 | 30 | 40 | 50 | 60 | 70 nullable
relation_description'Parent' | 'Child' | 'Sibling' | 'Spouse' | 'Partner' | 'Relative' | 'Other' nullable
updated_atstring date-time

Example response

{
  "links": {
    "self": "https://api.au1.cliniko.com/v1/relationships/1"
  },
  "patient": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/patients/1"
    }
  },
  "related_patient": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/patients/1"
    }
  }
}