POST api/EmailCampaign

Request Information

URI Parameters

None.

Body Parameters

EmailCampaignBody
NameDescriptionTypeAdditional information
ToAddresses

Collection of string

None.

Subject

string

None.

EmailBodyTemplate

string

None.

ClientName

string

None.

LicenseKey

string

None.

Request Formats

application/json, text/json

Sample:
{
  "ToAddresses": [
    "sample string 1",
    "sample string 2"
  ],
  "Subject": "sample string 1",
  "EmailBodyTemplate": "sample string 2",
  "ClientName": "sample string 3",
  "LicenseKey": "sample string 4"
}

text/html

Sample:
{"ToAddresses":["sample string 1","sample string 2"],"Subject":"sample string 1","EmailBodyTemplate":"sample string 2","ClientName":"sample string 3","LicenseKey":"sample string 4"}

application/xml, text/xml

Sample:
<EmailCampaignController.EmailCampaignBody xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SuntechSupportServices.Controllers.Email">
  <ClientName>sample string 3</ClientName>
  <EmailBodyTemplate>sample string 2</EmailBodyTemplate>
  <LicenseKey>sample string 4</LicenseKey>
  <Subject>sample string 1</Subject>
  <ToAddresses xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ToAddresses>
</EmailCampaignController.EmailCampaignBody>

application/x-www-form-urlencoded

Sample:

Sample not available.

multipart/form-data

Sample:
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ToAddresses[0]"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ToAddresses[1]"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Subject"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="EmailBodyTemplate"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ClientName"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="LicenseKey"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

EmailRequestApiResponse
NameDescriptionTypeAdditional information
Message

string

None.

Status

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Message": "sample string 1",
  "Status": "sample string 2"
}

text/html

Sample:
{"Message":"sample string 1","Status":"sample string 2"}

application/xml, text/xml

Sample:
<EmailCampaignController.EmailRequestApiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SuntechSupportServices.Controllers.Email">
  <Message>sample string 1</Message>
  <Status>sample string 2</Status>
</EmailCampaignController.EmailRequestApiResponse>

multipart/form-data

Sample:
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Message"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Status"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e--