v2

latestOpenAPI 3.0.32026-08-07222102695.9 KB

Communication

Create memo communication

Creating a memo with SMS or email as communication type will not send a communication.

A memo just records that a communication has taken place.

post/communications

Request body

category_code12 nullable

Enum Value	Description
12	Memo

confidentialboolean nullable

contentstring nullable

direction_code1 | 2 nullable

Enum Value	Description
1	Sent
2	Received

fromstring nullable

patient_idstring int64

patient id

tostring nullable

type_code1 | 2 | 3 | 4 nullable

Enum Value	Description
1	SMS
2	Email
3	Phone call
4	Other

Example request

{
  "patient_id": "1"
}

Response

Resource was created

archived_atstring date-time nullable

category'Memo' nullable

category_code12 nullable

Enum Value	Description
12	Memo

confidentialboolean nullable

contentstring nullable

created_atstring date-time

direction_code1 | 2 nullable

Enum Value	Description
1	Sent
2	Received

direction_description'Received' | 'Sent' nullable

fromstring nullable

idstring int64

tostring nullable

type'Email' | 'Other' | 'Phone call' | 'SMS' nullable

type_code1 | 2 | 3 | 4 nullable

Enum Value	Description
1	SMS
2	Email
3	Phone call
4	Other

updated_atstring date-time

Example response

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