v1
latestOpenAPI 3.1.02026-07-24447622848.7 KBReferrals
Partially Update Letter
patch/api/2.0/letters/{id}/
Path parameters
idinteger required
Request body
bodystring
The body of the letter.
created_datestring date-time nullable
deleted_datestring date-time nullable
delivery_datestring date-time nullable
delivery_method'direct' | 'email' | 'emr' | 'fax' | 'passport' | 'printed'
direct_message_statusstring nullable
direct_message_tostring nullable
display_tostring nullable
document_datestring date-time
email_tostring nullable
failure_unacknowledgedstring
fax_attachmentsboolean
fax_statusstring
fax_tostring nullable
idinteger
is_processedboolean
letter_typestring
patientinteger
practiceinteger
referral_orderinteger nullable
send_outboolean
send_to_elation_userinteger
If a letter is sent to another elation user, this will be that user's id.
send_to_namestring nullable
sign_datestring date-time nullable
signed_byinteger nullable
The user who signed the letter.
subjectstring
The subject of the letter (Not needed with referral_order).
tagsinteger[]
A list of Document Tags associated with the letter.
to_numberstring nullable
viewed_atstring date-time nullable
with_archiveboolean
Response
bodystring
The body of the letter.
created_datestring date-time nullable
deleted_datestring date-time nullable
delivery_datestring date-time nullable
delivery_method'direct' | 'email' | 'emr' | 'fax' | 'passport' | 'printed'
direct_message_statusstring nullable
direct_message_tostring nullable
display_tostring nullable
document_datestring date-time
email_tostring nullable
failure_unacknowledgedstring
fax_attachmentsboolean
fax_statusstring
fax_tostring nullable
idinteger
is_processedboolean
letter_typestring
patientinteger required
practiceinteger required
referral_orderinteger nullable
send_outboolean
send_to_elation_userinteger
If a letter is sent to another elation user, this will be that user's id.
send_to_namestring nullable
sign_datestring date-time nullable
signed_byinteger nullable
The user who signed the letter.
subjectstring
The subject of the letter (Not needed with referral_order).
tagsinteger[]
A list of Document Tags associated with the letter.
to_numberstring nullable
viewed_atstring date-time nullable
with_archiveboolean