Skip to main content
POST
Send Message
This endpoint is currently under construction. Please reach out to support if you'd like to use it.
This endpoint sends a secure message containing a note and attached documents to another practitioner in the network regarding a specific patient’s clinical journey. Sending a message is an asynchronous process. The response returns a Message object immediately with the status being processing. The id can be used to Get Message Status. When the recipient acknowledges receipt, or if delivery fails, a webhook request will be sent to your configured URL:
  • message.status: can be one of completed or failed, depending on the outcome of the operation.
See the Message Delivery guide for the explanation of the full flow.

Query Params

string
required
The ID of the Patient the message relates to.

Body

string
required
Where to deliver the message. Use List Network Entries with supportsMessaging=true to find a value, or pass one you already have. Can be an OID, or an email address.
string
required
The subject of the message. Think of it as the subject field in an email.
string
Plain-text content of the message. At least one of body or attachments is required.
string[]
Document IDs that have already been uploaded to Metriport to attach to the message. At least one of body or attachments is required.
string[]
Optional NPIs of the intended recipients. Useful when destination identifies an organization but the message is intended for specific practitioners.
Example Request Body:

Response

Returns the Message at the top level (not wrapped).
string
required
The ID of the message.
string
required
The ID of the Patient the message relates to.
string
required
One of outbound or inbound.
string
required
The delivery status. One of processing, completed, or failed.
string
required
How the message is transported. One of xdr or direct.
string
The network used for XDR delivery. One of EHEX, CAREQUALITY, or COMMONWELL. Required when transportMethod is xdr.
string
required
Where the message is delivered. An OID or a Direct email address.
string
required
The subject of the message.
string
Plain-text content of the message, when present.
string[]
Document IDs attached to the message, when present.
string[]
Intended recipient NPIs, when present.
string
required
ISO 8601 timestamp of when the message was created / accepted for send.
string
required
ISO 8601 timestamp of the latest status update.
string
Failure reason. Only present when status is failed.

Rate Limits

See limits and throttling