POST api/OutgoingSecureMessages

Send a message or draft one.

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
FromSecureRecipientExternalId	External ID of the sender of the secure message. This is the Secure Recipient's unique ID on integrating system (Required).	string	None.
FromSecureRecipientName	Name of the sender of the secure message. This is the Secure Recipient's name on the integrating system (Read only).	string	None.
Patients	List of patients that will receive the secure message.	Collection of PatientRecipientModel	None.
Subject	Subject of the secure message.	string	None.
Body	Body of the secure message.	string	None.
Status	Current status of the outgoing secure message. Possible values: Draft, Sent.	string	None.
Priority	Current priority of the outgoing secure messages. Possible values: Normal, High, Low.	string	None.
CreationDate	Creation date (Read only).	date	None.
SentDate	Sent date (Read only).	date	None.
FileData	List of file attachments	Collection of FileAttachmentModel	None.
Id	Unique ID of the model in the portal (Read only).	globally unique identifier	None.
ExternalId	Unique ID of the model on integrating system (Required).	string	None.

application/json, text/json

Sample:

{
  "fromSecureRecipientExternalId": "sample string 1",
  "fromSecureRecipientName": "sample string 2",
  "patients": [
    {
      "externalId": "sample string 1",
      "isRepresentative": true,
      "representativeExternalId": "sample string 3"
    },
    {
      "externalId": "sample string 1",
      "isRepresentative": true,
      "representativeExternalId": "sample string 3"
    }
  ],
  "subject": "sample string 3",
  "body": "sample string 4",
  "status": "sample string 5",
  "priority": "sample string 6",
  "creationDate": "2026-05-29T16:57:00.3151696+00:00",
  "sentDate": "2026-05-29T16:57:00.3152364+00:00",
  "fileData": [
    {
      "fileName": "sample string 1",
      "fileData": "QEA="
    },
    {
      "fileName": "sample string 1",
      "fileData": "QEA="
    }
  ],
  "id": "d13d3b4b-c197-4c8b-9d68-f4c1a23e99b1",
  "externalId": "sample string 9"
}

application/xml, text/xml

Sample:

<OutgoingSecureMessageModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.OutgoingSecureMessages">
  <ExternalId xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">sample string 9</ExternalId>
  <Id xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">d13d3b4b-c197-4c8b-9d68-f4c1a23e99b1</Id>
  <Body>sample string 4</Body>
  <CreationDate>2026-05-29T16:57:00.3151696+00:00</CreationDate>
  <FileData>
    <FileAttachmentModel>
      <FileData>QEA=</FileData>
      <FileName>sample string 1</FileName>
    </FileAttachmentModel>
    <FileAttachmentModel>
      <FileData>QEA=</FileData>
      <FileName>sample string 1</FileName>
    </FileAttachmentModel>
  </FileData>
  <FromSecureRecipientExternalId>sample string 1</FromSecureRecipientExternalId>
  <FromSecureRecipientName>sample string 2</FromSecureRecipientName>
  <Patients>
    <PatientRecipientModel>
      <ExternalId>sample string 1</ExternalId>
      <IsRepresentative>true</IsRepresentative>
      <RepresentativeExternalId>sample string 3</RepresentativeExternalId>
    </PatientRecipientModel>
    <PatientRecipientModel>
      <ExternalId>sample string 1</ExternalId>
      <IsRepresentative>true</IsRepresentative>
      <RepresentativeExternalId>sample string 3</RepresentativeExternalId>
    </PatientRecipientModel>
  </Patients>
  <Priority>sample string 6</Priority>
  <SentDate>2026-05-29T16:57:00.3152364+00:00</SentDate>
  <Status>sample string 5</Status>
  <Subject>sample string 3</Subject>
</OutgoingSecureMessageModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'OutgoingSecureMessageModel'.

Resource Description

OutgoingSecureMessageModel

Name	Description	Type	Additional information
FromSecureRecipientExternalId	External ID of the sender of the secure message. This is the Secure Recipient's unique ID on integrating system (Required).	string	None.
FromSecureRecipientName	Name of the sender of the secure message. This is the Secure Recipient's name on the integrating system (Read only).	string	None.
Patients	List of patients that will receive the secure message.	Collection of PatientRecipientModel	None.
Subject	Subject of the secure message.	string	None.
Body	Body of the secure message.	string	None.
Status	Current status of the outgoing secure message. Possible values: Draft, Sent.	string	None.
Priority	Current priority of the outgoing secure messages. Possible values: Normal, High, Low.	string	None.
CreationDate	Creation date (Read only).	date	None.
SentDate	Sent date (Read only).	date	None.
FileData	List of file attachments	Collection of FileAttachmentModel	None.
Id	Unique ID of the model in the portal (Read only).	globally unique identifier	None.
ExternalId	Unique ID of the model on integrating system (Required).	string	None.

Response Formats

application/json, text/json

Sample:

{
  "fromSecureRecipientExternalId": "sample string 1",
  "fromSecureRecipientName": "sample string 2",
  "patients": [
    {
      "externalId": "sample string 1",
      "isRepresentative": true,
      "representativeExternalId": "sample string 3"
    },
    {
      "externalId": "sample string 1",
      "isRepresentative": true,
      "representativeExternalId": "sample string 3"
    }
  ],
  "subject": "sample string 3",
  "body": "sample string 4",
  "status": "sample string 5",
  "priority": "sample string 6",
  "creationDate": "2026-05-29T16:57:00.3279792+00:00",
  "sentDate": "2026-05-29T16:57:00.3279792+00:00",
  "fileData": [
    {
      "fileName": "sample string 1",
      "fileData": "QEA="
    },
    {
      "fileName": "sample string 1",
      "fileData": "QEA="
    }
  ],
  "id": "28561aef-fb91-43a1-b1fe-a768638aeb31",
  "externalId": "sample string 9"
}

application/xml, text/xml

Sample:

<OutgoingSecureMessageModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.OutgoingSecureMessages">
  <ExternalId xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">sample string 9</ExternalId>
  <Id xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">28561aef-fb91-43a1-b1fe-a768638aeb31</Id>
  <Body>sample string 4</Body>
  <CreationDate>2026-05-29T16:57:00.3279792+00:00</CreationDate>
  <FileData>
    <FileAttachmentModel>
      <FileData>QEA=</FileData>
      <FileName>sample string 1</FileName>
    </FileAttachmentModel>
    <FileAttachmentModel>
      <FileData>QEA=</FileData>
      <FileName>sample string 1</FileName>
    </FileAttachmentModel>
  </FileData>
  <FromSecureRecipientExternalId>sample string 1</FromSecureRecipientExternalId>
  <FromSecureRecipientName>sample string 2</FromSecureRecipientName>
  <Patients>
    <PatientRecipientModel>
      <ExternalId>sample string 1</ExternalId>
      <IsRepresentative>true</IsRepresentative>
      <RepresentativeExternalId>sample string 3</RepresentativeExternalId>
    </PatientRecipientModel>
    <PatientRecipientModel>
      <ExternalId>sample string 1</ExternalId>
      <IsRepresentative>true</IsRepresentative>
      <RepresentativeExternalId>sample string 3</RepresentativeExternalId>
    </PatientRecipientModel>
  </Patients>
  <Priority>sample string 6</Priority>
  <SentDate>2026-05-29T16:57:00.3279792+00:00</SentDate>
  <Status>sample string 5</Status>
  <Subject>sample string 3</Subject>
</OutgoingSecureMessageModel>

Eye Reach Patients API Reference

Request Information

URI Parameters

Body Parameters

Request Formats

application/json, text/json

application/xml, text/xml

application/x-www-form-urlencoded

Response Information

Resource Description

Response Formats

application/json, text/json

application/xml, text/xml