Skip to main content
POST
Send an intramail message (or save a draft)

Authorizations

Authorization
string
header
required

Marketplace API key

Headers

idempotency-key
string
x-session-token
string

The App Bridge token of the logged-in user (maxcare.appToken()), verified for this app and organization. With it the request reaches that user's own mail; without it, the mail of the API key's creator. A token that does not verify is 401 authorizer_unverified. Sent as a header so GET requests keep it out of URLs.

X-Organization-Id
string
required

Target clinic organization ID

Body

application/json
to
object[]
required

Required unless draft is true

subject
string
required
Maximum string length: 255
body
string
required
Maximum string length: 50000
cc
object[]
priority
enum<string>
default:normal
Available options:
low,
normal,
high
patientId
string

Link a patient (pat_…). A facility-limited key must link a message with a patient recipient (here or through noteId).

noteId
string

Link a visit note (nte_…); its patient is linked too

draft
boolean
default:false

Save as a draft instead of sending

mailboxId
string

Mailbox (imb_…) from GET /intramail/status: one of the acting user's EHR logins. Defaults to the one marked isDefault.

Response

Created

code
string
required

Response code

Example:

"success"

data
object
required