latestOpenAPI 3.0.0Apache 2.02026-08-201250995.7 KB

bd9694db5fce

Client Communication

Log a new Client Communication history

Manually register a new communication between a Clinic and a PetParent

post/api/v1/client-communications

user_idinteger

Id of the PetParent that the Clinic communicates to.

patient_idsinteger[]

Id of the patients related to the communication.

clinic_idinteger

Id of the Clinic from where the communication is made from.

channel'phone' | 'other'

The channel of the communication. Enum. One of phone, other, sms, email. API limited only to phone & other.

subjectstring

The subject of communication.

contentstring

The content of communication. (required for email)

destinationstring

Where the communication is sent to ( only for sms/email/phone ).

communicated_atstring

The communicated_at when the communication was made.

message_idstring

The id used for identifying attachments when channel is mail.

successful operation