POST api/email/send

Makes a request to send an email.

Request Information

URI Parameters

None.

Body Parameters

The details of the email requested to be sent.

Name	Description	Type	Additional information
FromAddress	The email address to send the email from	string	Required Max length: 128
ToAddresses	The email addresses to send the email to	Collection of string	Required Minimum Count: 1
CcAddresses	The email addresses to CC on the email	Collection of string	None.
BccAddresses	The email addresses to Bcc on the email	Collection of string	None.
Subject	The subject of the email	string	Required Max length: 1024
EmailBody	The body of the email.	string	Required Min length: 1
HtmlBody	Is the body HTML or plain text	boolean	Default value is false
SendEmailsSeparately	Should each recipient have the email sent to them separately	boolean	Default value is false
ReferenceId	An optional reference number that can be used with the ApplicationId to retrieve the status of the email later.	integer	None.
ApplicationId	An optional application id that can be used with the ReferenceId to retrieve the status of the email later.	integer	None.
Attachments	Attachments for the email.	Collection of SendEmailRequestAttachment	None.

Request Formats

application/json, text/json

Sample:

{
  "FromAddress": "sample string 1",
  "ToAddresses": [
    "sample string 1",
    "sample string 2"
  ],
  "CcAddresses": [
    "sample string 1",
    "sample string 2"
  ],
  "BccAddresses": [
    "sample string 1",
    "sample string 2"
  ],
  "Subject": "sample string 2",
  "EmailBody": "sample string 3",
  "HtmlBody": true,
  "SendEmailsSeparately": true,
  "ReferenceId": 1,
  "ApplicationId": 1,
  "Attachments": [
    {
      "FileName": "sample string 1",
      "Content": "QEA="
    },
    {
      "FileName": "sample string 1",
      "Content": "QEA="
    }
  ]
}

application/xml, text/xml

Sample:

<SendEmailRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <FromAddress>sample string 1</FromAddress>
  <ToAddresses>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </ToAddresses>
  <CcAddresses>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </CcAddresses>
  <BccAddresses>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </BccAddresses>
  <Subject>sample string 2</Subject>
  <EmailBody>sample string 3</EmailBody>
  <HtmlBody>true</HtmlBody>
  <SendEmailsSeparately>true</SendEmailsSeparately>
  <ReferenceId>1</ReferenceId>
  <ApplicationId>1</ApplicationId>
  <Attachments>
    <SendEmailRequestAttachment>
      <FileName>sample string 1</FileName>
      <Content>QEA=</Content>
    </SendEmailRequestAttachment>
    <SendEmailRequestAttachment>
      <FileName>sample string 1</FileName>
      <Content>QEA=</Content>
    </SendEmailRequestAttachment>
  </Attachments>
</SendEmailRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

An object detailing if the queuing of the email was successful

SendEmailResponse

Name	Description	Type	Additional information
Success	Did the request succeed	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true
}

application/xml, text/xml

Sample:

<SendEmailResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Success>true</Success>
</SendEmailResponse>