POST api/Campaigns/SendEmails

This API allows you to send emails from Digital Communication. To be used with the GetEmails API to know the EmailID, merge fields, etc. required to send the email.

Request Information

URI Parameters

None.

Body Parameters

SendEmailsRequestModel

Name	Description	Type	Additional information
EmailID	Unqiue indicator pointing to the email you want to send	string	None.
EmailLaunches	List of emails to be launched. May send the email up to 10 email addresses (this will send up to 10 separate emails).	Collection of EmailLaunch	None.

Request Formats

application/json, text/json

Sample:

{
  "EmailID": "sample string 1",
  "EmailLaunches": [
    {
      "EmailAddress": "sample string 1",
      "MobileNumber": "sample string 2",
      "UsedMergeFields": [
        {
          "Name": "sample string 1",
          "Value": "sample string 2",
          "ReplaceName": "sample string 3"
        },
        {
          "Name": "sample string 1",
          "Value": "sample string 2",
          "ReplaceName": "sample string 3"
        }
      ],
      "CustomField1": "sample string 3",
      "CustomField2": "sample string 4",
      "AntiPhishingField": "sample string 5"
    },
    {
      "EmailAddress": "sample string 1",
      "MobileNumber": "sample string 2",
      "UsedMergeFields": [
        {
          "Name": "sample string 1",
          "Value": "sample string 2",
          "ReplaceName": "sample string 3"
        },
        {
          "Name": "sample string 1",
          "Value": "sample string 2",
          "ReplaceName": "sample string 3"
        }
      ],
      "CustomField1": "sample string 3",
      "CustomField2": "sample string 4",
      "AntiPhishingField": "sample string 5"
    }
  ]
}

application/xml, text/xml

Sample:

<SendEmailsRequestModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <EmailID>sample string 1</EmailID>
  <CompanyID>sample string 2</CompanyID>
  <EmailLaunches>
    <EmailLaunch>
      <EmailAddress>sample string 1</EmailAddress>
      <MobileNumber>sample string 2</MobileNumber>
      <UsedMergeFields>
        <MergeField>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
          <ReplaceName>sample string 3</ReplaceName>
        </MergeField>
        <MergeField>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
          <ReplaceName>sample string 3</ReplaceName>
        </MergeField>
      </UsedMergeFields>
      <CustomField1>sample string 3</CustomField1>
      <CustomField2>sample string 4</CustomField2>
      <AntiPhishingField>sample string 5</AntiPhishingField>
    </EmailLaunch>
    <EmailLaunch>
      <EmailAddress>sample string 1</EmailAddress>
      <MobileNumber>sample string 2</MobileNumber>
      <UsedMergeFields>
        <MergeField>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
          <ReplaceName>sample string 3</ReplaceName>
        </MergeField>
        <MergeField>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
          <ReplaceName>sample string 3</ReplaceName>
        </MergeField>
      </UsedMergeFields>
      <CustomField1>sample string 3</CustomField1>
      <CustomField2>sample string 4</CustomField2>
      <AntiPhishingField>sample string 5</AntiPhishingField>
    </EmailLaunch>
  </EmailLaunches>
</SendEmailsRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SendEmailsResponseModel

Name	Description	Type	Additional information
EmailsSuccessfullyProccessed	Count of how many emails were processed successfully	integer	None.
SMSSuccessfullyProccessed	Count of how many sms text messages were processed successfully	integer	None.
InvalidRecords	list of emails that did not pass validation	Collection of InvalidRecord	None.
IsSuccessful	Indicator of whether the request was successful	boolean	None.
ErrorMessage	This will contain details of the error if it was not successful	string	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 4",
  "EmailsSuccessfullyProccessed": 1,
  "SMSSuccessfullyProccessed": 2,
  "InvalidRecords": [
    {
      "Description": "sample string 1",
      "EmailAddress": "sample string 2",
      "MobileNumber": "sample string 3",
      "MergeFieldList": [
        {
          "Name": "sample string 1",
          "Value": "sample string 2",
          "ReplaceName": "sample string 3"
        },
        {
          "Name": "sample string 1",
          "Value": "sample string 2",
          "ReplaceName": "sample string 3"
        }
      ],
      "Custom1": "sample string 4",
      "Custom2": "sample string 5",
      "AntiPhishing": "sample string 6",
      "TrackingId": "sample string 7"
    },
    {
      "Description": "sample string 1",
      "EmailAddress": "sample string 2",
      "MobileNumber": "sample string 3",
      "MergeFieldList": [
        {
          "Name": "sample string 1",
          "Value": "sample string 2",
          "ReplaceName": "sample string 3"
        },
        {
          "Name": "sample string 1",
          "Value": "sample string 2",
          "ReplaceName": "sample string 3"
        }
      ],
      "Custom1": "sample string 4",
      "Custom2": "sample string 5",
      "AntiPhishing": "sample string 6",
      "TrackingId": "sample string 7"
    }
  ]
}

application/xml, text/xml

Sample:

<SendEmailsResponseModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <IsSuccessful>true</IsSuccessful>
  <ErrorMessage>sample string 4</ErrorMessage>
  <EmailsSuccessfullyProccessed>1</EmailsSuccessfullyProccessed>
  <SMSSuccessfullyProccessed>2</SMSSuccessfullyProccessed>
  <InvalidRecords>
    <InvalidRecord>
      <Description>sample string 1</Description>
      <EmailAddress>sample string 2</EmailAddress>
      <MobileNumber>sample string 3</MobileNumber>
      <MergeFieldList>
        <MergeField>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
          <ReplaceName>sample string 3</ReplaceName>
        </MergeField>
        <MergeField>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
          <ReplaceName>sample string 3</ReplaceName>
        </MergeField>
      </MergeFieldList>
      <Custom1>sample string 4</Custom1>
      <Custom2>sample string 5</Custom2>
      <AntiPhishing>sample string 6</AntiPhishing>
      <TrackingId>sample string 7</TrackingId>
    </InvalidRecord>
    <InvalidRecord>
      <Description>sample string 1</Description>
      <EmailAddress>sample string 2</EmailAddress>
      <MobileNumber>sample string 3</MobileNumber>
      <MergeFieldList>
        <MergeField>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
          <ReplaceName>sample string 3</ReplaceName>
        </MergeField>
        <MergeField>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
          <ReplaceName>sample string 3</ReplaceName>
        </MergeField>
      </MergeFieldList>
      <Custom1>sample string 4</Custom1>
      <Custom2>sample string 5</Custom2>
      <AntiPhishing>sample string 6</AntiPhishing>
      <TrackingId>sample string 7</TrackingId>
    </InvalidRecord>
  </InvalidRecords>
  <UploadIDs>
    <int>1</int>
    <int>2</int>
  </UploadIDs>
</SendEmailsResponseModel>