POST api/TransactionalEmail

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
APIVersion	integer	None.
DripId	string	None.
Subject	string	None.
fromEmailAddress	string	None.
fromDisplayName	string	None.
toEmailAddress	string	None.
toDisplayName	string	None.
CRMId	string	None.
CRMType	string	None.
mergeData	Dictionary of string [key] and string [value]	None.

Request Formats

application/json, text/json

Sample:

{
  "APIVersion": 1,
  "DripId": "sample string 2",
  "Subject": "sample string 3",
  "fromEmailAddress": "sample string 4",
  "fromDisplayName": "sample string 5",
  "toEmailAddress": "sample string 6",
  "toDisplayName": "sample string 7",
  "CRMId": "sample string 8",
  "CRMType": "sample string 9",
  "mergeData": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample:

<TransactionalEmail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EngageCL.Engage">
  <APIVersion>1</APIVersion>
  <CRMId>sample string 8</CRMId>
  <CRMType>sample string 9</CRMType>
  <DripId>sample string 2</DripId>
  <Subject>sample string 3</Subject>
  <fromDisplayName>sample string 5</fromDisplayName>
  <fromEmailAddress>sample string 4</fromEmailAddress>
  <mergeData xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </mergeData>
  <toDisplayName>sample string 7</toDisplayName>
  <toEmailAddress>sample string 6</toEmailAddress>
</TransactionalEmail>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseService

Name	Type	Additional information
validRequest	boolean	None.
RequestMessage	string	None.
EntityName	string	None.
EntityId	string	None.
URL	string	None.
APIVersion	string	None.

Response Formats

application/json, text/json

Sample:

{
  "validRequest": true,
  "RequestMessage": "sample string 2",
  "EntityName": "sample string 3",
  "EntityId": "sample string 4",
  "URL": "sample string 5",
  "APIVersion": "sample string 6"
}

application/xml, text/xml

Sample:

<ResponseService xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EngageCL.Engage">
  <APIVersion>sample string 6</APIVersion>
  <EntityId>sample string 4</EntityId>
  <EntityName>sample string 3</EntityName>
  <RequestMessage>sample string 2</RequestMessage>
  <URL>sample string 5</URL>
  <validRequest>true</validRequest>
</ResponseService>