Skip to main content
POST
Send a fax

Authorizations

Authorization
string
header
required

Marketplace API key

Headers

X-Organization-Id
string
required

Target clinic organization ID

Body

application/json
patientId
string
required

Patient whose chart the fax is sent from

Example:

"8de03039-3a9e-417a-b2b3-a8b8df183631"

toNumber
string
required

Destination fax number (10-digit US, punctuation allowed)

Example:

"(734) 714-8907"

idempotencyKey
string
required

Caller-generated key that makes this send idempotent. A repeat with the same key never dials: it returns the original fax record as it currently stands — including a failed one — so re-asking after an unknown outcome is always safe, and clearing a stuck row can never put a second copy on the recipient's machine. While the first send is still in flight you get 503 — repeat the SAME request shortly, and never mint a new key for it: that would put a second copy on the recipient's machine. A 409 is a different thing entirely — the key was already used for a DIFFERENT fax, and only then is a new key the right answer. To deliberately send again, use a NEW key. Two sends match when the patient, destination, attachments, inline file (bytes, name and type), subject and cover template match; recipientName is NOT part of that comparison, because it is recorded with the fax but never reaches the EHR or the printed page. The key is scoped to (your app, this organization), is honoured for the life of the fax record, and never expires.

Example:

"pa-renewal-2026-08-25-patient-8de03039"

subject
string

Line printed on the cover page

Example:

"Prior Auth Request"

recipientName
string

Recipient name, recorded with the send

Example:

"McLaren Health Plan"

documentIds
string[]

Chart documents to attach, by the IDs returned from GET /patients/{id}/documents

Example:
file
object

A file to fax that is not yet in the chart. NOTE: faxing happens from the chart, so this file is filed as a chart document and becomes part of the medical record.

templateId
string

Cover-page template ID from GET /faxes/templates. Defaults to the practice's document template.

Example:

"6278"

Response

Success

code
string
required

Response code

Example:

"success"

data
object
required