Skip to main content
POST
Create an imported conversation

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Schema for creating an imported conversation via the Connect API.

clinic_client_id
integer
required

The ID of the clinic client (pet parent) the conversation is about.

text
string
required

The full conversation transcript, stored and rendered verbatim in the Vetcove patient timeline.

Minimum string length: 1
attachment_uploaded_file_ids
integer[]

IDs of files previously uploaded via POST /file-uploads/ that belong to this conversation.

clinic_patient_id
integer | null

The ID of the clinic patient the conversation is about. When omitted, the conversation is attached to every active patient of the clinic client so that it surfaces on every one of the client's patient timelines.

title
string | null

Short label shown in the patient timeline preview row.

Maximum string length: 255

Response

201 - application/json

Created

attachment_uploaded_file_ids
integer[]
required

IDs of uploaded files attached to this conversation. Clients fetch the underlying file bytes via the /file-uploads/ endpoints.

clinic_client_id
integer
required

The ID of the clinic client (pet parent) the conversation is about.

clinic_id
integer
required

The ID of the clinic the conversation belongs to.

clinic_patient_ids
integer[]
required

The IDs of the clinic patients the conversation is attached to. Conversations submitted without a patient are fanned out to every active patient of the client at ingest time.

created
string<date-time>
required

The datetime this object was created.

id
integer
required

The ID of the imported conversation record.

modified
string<date-time>
required

The datetime this object was last modified; changes to related entities will not update this field.

text
string
required

The full conversation transcript, stored and rendered verbatim in the Vetcove patient timeline.

title
string | null
required

Short label shown in the patient timeline preview row.