POST api/messages/templated

Sends a templated e-mail message.

Request Information

URI Parameters

None.

Body Parameters

Messages to send.

Collection of SendTemplatedEmailMessageDTO

Name	Description	Type	Additional information
From	A valid e-mail address.	string	None.
To	A valid e-mail address.	string	None.
CarbonCopy	CC, a valid e-mail address, or a comma-separated array of e-mail addresses.	string	None.
BlindCarbonCopy	BCC, a valid e-mail address.	string	None.
Category	E-mail template category.	string	None.
Code	E-mail template code	string	None.
Variables	JSON-encoded e-mail template variables and their values. Use empty object "{}" when none are necessary.	string	None.
DocumentURL	URL where the document is stored. Must be in PDF format.	string	None.
DocumentId	Document Id.	string	None.
AttachmentType	Valid values are "attachment" for attachments, and "link" to add the document as a link.	string	None.
ApplicationType	Currently supported application types: retail. Can be null/empty if you don't want to track message status via a callback.	string	None.
PrintDTOURL	Print DTO URL - used when DocumentURL is not specified.	string	None.
DocumentTemplateCategory	Document template category - used when DocumentURL is not specified	string	None.
DocumentTemplateCode	Document template code - used when DocumentURL is not specified	string	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "From": "sample string 1",
    "To": "sample string 2",
    "CarbonCopy": "sample string 3",
    "BlindCarbonCopy": "sample string 4",
    "Category": "sample string 5",
    "Code": "sample string 6",
    "Variables": "sample string 7",
    "DocumentURL": "sample string 8",
    "DocumentId": "sample string 9",
    "AttachmentType": "sample string 10",
    "ApplicationType": "sample string 11",
    "PrintDTOURL": "sample string 12",
    "DocumentTemplateCategory": "sample string 13",
    "DocumentTemplateCode": "sample string 14"
  },
  {
    "From": "sample string 1",
    "To": "sample string 2",
    "CarbonCopy": "sample string 3",
    "BlindCarbonCopy": "sample string 4",
    "Category": "sample string 5",
    "Code": "sample string 6",
    "Variables": "sample string 7",
    "DocumentURL": "sample string 8",
    "DocumentId": "sample string 9",
    "AttachmentType": "sample string 10",
    "ApplicationType": "sample string 11",
    "PrintDTOURL": "sample string 12",
    "DocumentTemplateCategory": "sample string 13",
    "DocumentTemplateCode": "sample string 14"
  }
]

text/html

Sample:

[{"From":"sample string 1","To":"sample string 2","CarbonCopy":"sample string 3","BlindCarbonCopy":"sample string 4","Category":"sample string 5","Code":"sample string 6","Variables":"sample string 7","DocumentURL":"sample string 8","DocumentId":"sample string 9","AttachmentType":"sample string 10","ApplicationType":"sample string 11","PrintDTOURL":"sample string 12","DocumentTemplateCategory":"sample string 13","DocumentTemplateCode":"sample string 14"},{"From":"sample string 1","To":"sample string 2","CarbonCopy":"sample string 3","BlindCarbonCopy":"sample string 4","Category":"sample string 5","Code":"sample string 6","Variables":"sample string 7","DocumentURL":"sample string 8","DocumentId":"sample string 9","AttachmentType":"sample string 10","ApplicationType":"sample string 11","PrintDTOURL":"sample string 12","DocumentTemplateCategory":"sample string 13","DocumentTemplateCode":"sample string 14"}]

application/xml, text/xml

Sample:

<ArrayOfSendTemplatedEmailMessageDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.WebAPI.DTOs">
  <SendTemplatedEmailMessageDTO>
    <ApplicationType>sample string 11</ApplicationType>
    <AttachmentType>sample string 10</AttachmentType>
    <BlindCarbonCopy>sample string 4</BlindCarbonCopy>
    <CarbonCopy>sample string 3</CarbonCopy>
    <Category>sample string 5</Category>
    <Code>sample string 6</Code>
    <DocumentId>sample string 9</DocumentId>
    <DocumentTemplateCategory>sample string 13</DocumentTemplateCategory>
    <DocumentTemplateCode>sample string 14</DocumentTemplateCode>
    <DocumentURL>sample string 8</DocumentURL>
    <From>sample string 1</From>
    <PrintDTOURL>sample string 12</PrintDTOURL>
    <To>sample string 2</To>
    <Variables>sample string 7</Variables>
  </SendTemplatedEmailMessageDTO>
  <SendTemplatedEmailMessageDTO>
    <ApplicationType>sample string 11</ApplicationType>
    <AttachmentType>sample string 10</AttachmentType>
    <BlindCarbonCopy>sample string 4</BlindCarbonCopy>
    <CarbonCopy>sample string 3</CarbonCopy>
    <Category>sample string 5</Category>
    <Code>sample string 6</Code>
    <DocumentId>sample string 9</DocumentId>
    <DocumentTemplateCategory>sample string 13</DocumentTemplateCategory>
    <DocumentTemplateCode>sample string 14</DocumentTemplateCode>
    <DocumentURL>sample string 8</DocumentURL>
    <From>sample string 1</From>
    <PrintDTOURL>sample string 12</PrintDTOURL>
    <To>sample string 2</To>
    <Variables>sample string 7</Variables>
  </SendTemplatedEmailMessageDTO>
</ArrayOfSendTemplatedEmailMessageDTO>

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 'IEnumerable`1'.

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.