Skip to main content
PATCH
Partially Update Letter

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

id
integer<int64>
required

Body

application/json
attachments
object[]
body
string

The body of the letter.

delivery_date
string<date-time> | null
delivery_method
enum<string>
Available options:
direct,
email,
emr,
fax,
passport,
printed
direct_message_to
string | null
Maximum string length: 200
document_date
string<date-time>
email_to
string | null
Maximum string length: 200
failure_unacknowledged
string
fax_attachments
boolean
fax_to
string | null
Maximum string length: 20
patient
integer<int64>
practice
integer<int64>
referral_order
integer<int64> | null
send_out
boolean
send_to_contact
object
send_to_name
string | null
Maximum string length: 200
sign_date
string<date-time> | null
signed_by
integer<int64> | null

The user who signed the letter.

subject
string

The subject of the letter (Not needed with referral_order).

Maximum string length: 200
tags
integer<int64>[]

A list of Document Tags associated with the letter.

viewed_at
string<date-time> | null
with_archive
boolean

Response

200 - application/json
patient
integer<int64>
required
practice
integer<int64>
required
send_to_contact
object
required
attachments
object[]
body
string

The body of the letter.

created_date
string<date-time> | null
read-only
deleted_date
string<date-time> | null
read-only
delivery_date
string<date-time> | null
delivery_method
enum<string>
Available options:
direct,
email,
emr,
fax,
passport,
printed
direct_message_status
string | null
read-only
direct_message_to
string | null
Maximum string length: 200
display_to
string | null
read-only
document_date
string<date-time>
email_to
string | null
Maximum string length: 200
failure_unacknowledged
string
fax_attachments
boolean
fax_status
string
read-only
fax_to
string | null
Maximum string length: 20
id
integer
read-only
is_processed
boolean
read-only
letter_type
string
read-only
referral_order
integer<int64> | null
send_out
boolean
send_to_elation_user
integer
read-only

If a letter is sent to another elation user, this will be that user's id.

send_to_name
string | null
Maximum string length: 200
sign_date
string<date-time> | null
signed_by
integer<int64> | null

The user who signed the letter.

subject
string

The subject of the letter (Not needed with referral_order).

Maximum string length: 200
tags
integer<int64>[]

A list of Document Tags associated with the letter.

to_number
string | null
read-only
viewed_at
string<date-time> | null
with_archive
boolean