Sign in
Patient Letters (BETA)

Partially Update Patient Letter

Update a patient letter. PATCH {signLog:...} to sign. PATCH {send_out:true} to send after signing. PATCH {patient_read_time:<ts>} to acknowledge.

patch/api/2.0/patient_letters/{id}/

Path parameters

idinteger required

Request body

bodystring
categoryinteger nullable
created_datestring date-time nullable
deleted_datestring date-time nullable
delivery_datestring date-time nullable
document_datestring date-time
idinteger
is_patient_initiatedboolean nullable
is_processedboolean
letter_typestring
patientinteger
patient_read_timestring date-time nullable
practiceinteger
send_outboolean
send_to_patientboolean
sign_datestring date-time nullable
signed_byinteger nullable

The user who signed the letter.

subjectstring
tagsinteger[]

A list of Document Tags associated with the letter.

viewed_atstring date-time nullable

Response

bodystring
categoryinteger nullable
created_datestring date-time nullable
deleted_datestring date-time nullable
delivery_datestring date-time nullable
document_datestring date-time
idinteger
is_patient_initiatedboolean nullable
is_processedboolean
letter_typestring
patientinteger required
patient_read_timestring date-time nullable
practiceinteger required
send_outboolean
send_to_patientboolean
sign_datestring date-time nullable
signed_byinteger nullable

The user who signed the letter.

subjectstring
tagsinteger[]

A list of Document Tags associated with the letter.

viewed_atstring date-time nullable

Changes

No recorded changes to this endpoint across all 1 revision of this API.