v1

latestOpenAPI 3.1.0Private2026-07-24196240439.2 KB

DocumentInteraction

Update Interaction

patch/provider/patients/{patient_id}/interactions/document/{id}

Path parameters

patient_idstring required

Unique Patient ID

idstring required

Unique Document Interaction ID

Request body

status'draft' | 'signed' | 'addended' | 'deleted' | 'failed' required

The status of the interaction.

titlestring

The title of the interaction.

bodystring

The body of the interaction.

attachmentsstring[]

The attachments of the interaction. Files will be downloaded as part of the request. If provided it will OVERRIDE the attachments on the interaction so make sure to provide all the attachments if you want to keep them.

event_timestampstring date-time

The event timestamp of the interaction.

integration_record_idstring

integration_error_messagestring

integration_web_linkstring

Response

Successful response

idstring

bodystring

event_timestampstring date-time

patient_accessboolean

patient_idstring

statusstring

titlestring

typestring