POST api/CommunicationRequest?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&Mode={Mode}

Sends communications

Request Information

URI Parameters

Name	Description	Type	Additional information
VendorID		string	Required
VendorPassword		string	Required
APIGUID		string	Required
Mode	0: Simple, 1: Batch	CommunicationMode	Required

Body Parameters

Communication Request structure

SendRequest

Name	Type	Additional information
EmployeeKey	integer	None.
DeliverFrom	string	None.
Subject	string	None.
Body	string	None.
TextMessage	string	None.
HTMLTemplate	string	None.
DeliveryTime	date	None.
DeliverCC	string	None.
DeliverTo	Collection of Delivery	None.
Attachments	Collection of Attachment	None.
DocumentRequestAttachments	Collection of DocumentRequest	None.
WebFormType	integer	None.
WebFormParentKey	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "EmployeeKey": 1,
  "DeliverFrom": "sample string 2",
  "Subject": "sample string 3",
  "Body": "sample string 4",
  "TextMessage": "sample string 5",
  "HTMLTemplate": "sample string 6",
  "DeliveryTime": "2025-10-27T12:12:39.9691472-07:00",
  "DeliverCC": "sample string 8",
  "DeliverTo": [
    {
      "ResidentKey": 1,
      "ResidentContactKey": 2,
      "ParentKey": 3,
      "ResidentNoteKey": 4,
      "ToAddress": "sample string 5",
      "ToDeviceType": "sample string 6",
      "Subject": "sample string 7",
      "Body": "sample string 8",
      "TextMessage": "sample string 9"
    },
    {
      "ResidentKey": 1,
      "ResidentContactKey": 2,
      "ParentKey": 3,
      "ResidentNoteKey": 4,
      "ToAddress": "sample string 5",
      "ToDeviceType": "sample string 6",
      "Subject": "sample string 7",
      "Body": "sample string 8",
      "TextMessage": "sample string 9"
    }
  ],
  "Attachments": [
    {
      "FileName": "sample string 1",
      "ImageBase64": "sample string 2"
    },
    {
      "FileName": "sample string 1",
      "ImageBase64": "sample string 2"
    }
  ],
  "DocumentRequestAttachments": [
    {
      "DocumentArea": 1,
      "DocumentKey": 2,
      "CompanyKey": 3,
      "AccountKey": 4,
      "ResidentContactKey": 5,
      "BaseURL": "sample string 6",
      "OutputType": "sample string 7",
      "Filename": "sample string 8"
    },
    {
      "DocumentArea": 1,
      "DocumentKey": 2,
      "CompanyKey": 3,
      "AccountKey": 4,
      "ResidentContactKey": 5,
      "BaseURL": "sample string 6",
      "OutputType": "sample string 7",
      "Filename": "sample string 8"
    }
  ],
  "WebFormType": 9,
  "WebFormParentKey": 10
}

application/xml, text/xml

Sample:

<SendRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VMSRXChange.DataClassesCommunicationRequest">
  <Attachments>
    <Attachment>
      <FileName>sample string 1</FileName>
      <ImageBase64>sample string 2</ImageBase64>
    </Attachment>
    <Attachment>
      <FileName>sample string 1</FileName>
      <ImageBase64>sample string 2</ImageBase64>
    </Attachment>
  </Attachments>
  <Body>sample string 4</Body>
  <DeliverCC>sample string 8</DeliverCC>
  <DeliverFrom>sample string 2</DeliverFrom>
  <DeliverTo>
    <Delivery>
      <Body>sample string 8</Body>
      <ParentKey>3</ParentKey>
      <ResidentContactKey>2</ResidentContactKey>
      <ResidentKey>1</ResidentKey>
      <ResidentNoteKey>4</ResidentNoteKey>
      <Subject>sample string 7</Subject>
      <TextMessage>sample string 9</TextMessage>
      <ToAddress>sample string 5</ToAddress>
      <ToDeviceType>sample string 6</ToDeviceType>
    </Delivery>
    <Delivery>
      <Body>sample string 8</Body>
      <ParentKey>3</ParentKey>
      <ResidentContactKey>2</ResidentContactKey>
      <ResidentKey>1</ResidentKey>
      <ResidentNoteKey>4</ResidentNoteKey>
      <Subject>sample string 7</Subject>
      <TextMessage>sample string 9</TextMessage>
      <ToAddress>sample string 5</ToAddress>
      <ToDeviceType>sample string 6</ToDeviceType>
    </Delivery>
  </DeliverTo>
  <DeliveryTime>2025-10-27T12:12:39.9691472-07:00</DeliveryTime>
  <DocumentRequestAttachments xmlns:d2p1="http://schemas.datacontract.org/2004/07/VMSRXChange.DataClassesDocument">
    <d2p1:DocumentRequest>
      <d2p1:AccountKey>4</d2p1:AccountKey>
      <d2p1:BaseURL>sample string 6</d2p1:BaseURL>
      <d2p1:CompanyKey>3</d2p1:CompanyKey>
      <d2p1:DocumentArea>1</d2p1:DocumentArea>
      <d2p1:DocumentKey>2</d2p1:DocumentKey>
      <d2p1:Filename>sample string 8</d2p1:Filename>
      <d2p1:OutputType>sample string 7</d2p1:OutputType>
      <d2p1:ResidentContactKey>5</d2p1:ResidentContactKey>
    </d2p1:DocumentRequest>
    <d2p1:DocumentRequest>
      <d2p1:AccountKey>4</d2p1:AccountKey>
      <d2p1:BaseURL>sample string 6</d2p1:BaseURL>
      <d2p1:CompanyKey>3</d2p1:CompanyKey>
      <d2p1:DocumentArea>1</d2p1:DocumentArea>
      <d2p1:DocumentKey>2</d2p1:DocumentKey>
      <d2p1:Filename>sample string 8</d2p1:Filename>
      <d2p1:OutputType>sample string 7</d2p1:OutputType>
      <d2p1:ResidentContactKey>5</d2p1:ResidentContactKey>
    </d2p1:DocumentRequest>
  </DocumentRequestAttachments>
  <EmployeeKey>1</EmployeeKey>
  <HTMLTemplate>sample string 6</HTMLTemplate>
  <Subject>sample string 3</Subject>
  <TextMessage>sample string 5</TextMessage>
  <WebFormParentKey>10</WebFormParentKey>
  <WebFormType>9</WebFormType>
</SendRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.