Campaign API

Our Campaign Management Methods

CreateCampaign()

Use this method to create a new email campaign

  • apiKey (Required)

Your application authentication key. To get yours, click here.

  • name (Required)

Name of the campaign to be created

  • subject (Required)

Subject line for the new campaign

  • template (Required)

ID of the template to be used in this campaign

  • list (Required)

ID of the contact list to be used in this campaign

  • timetosend (Required)

Preferred Date and Time for the campaign delivery (in MM/DD/YYYY HH:NN:SS AM format)

  • fromEmail (Required)

ID of the From Email be used in this campaign

On success, this method returns a “success” response (code 0). Also unique ID of the newly created campaign will be provided in campaign_id field. On failure, an error code with description will be returned.



<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CreateCampaign xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
      <name>string</name>
      <subject>string</subject>
      <template>int</template>
      <list>int</list>
      <timetosend>dateTime</timetosend>
      <mailfrom>int</mailfrom>
    </CreateCampaign>
  </soap:Body>
</soap:Envelope>



<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CreateCampaignResponse xmlns="http://api.directiq.com/">
      <CreateCampaignResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
        <campaign_id>int</campaign_id>
      </CreateCampaignResult>
    </CreateCampaignResponse>
  </soap:Body>
</soap:Envelope>

GetFromEmails()

Use this method to create a new email campaign

  • apiKey (Required)

Your application authentication key. To get yours, click here.

On success, this method returns a Success with the following information: id : unique ID of the from email, use this ID in the CreateCampaign method. fromEmail : from email address fromName : from name On failure, this method returns an error code and a description.



<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetFromEmails xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
    </GetFromEmails>
  </soap:Body>
</soap:Envelope>



<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetFromEmailsResponse xmlns="http://api.directiq.com/">
      <GetFromEmailsResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
        <returnedEmails>
          <client_from>
            <id>int</id>
            <client_id>int</client_id>
            <fromEmail>string</fromEmail>
            <zaman>dateTime</zaman>
            <isConfirmed>boolean</isConfirmed>
            <fromName>string</fromName>
          </client_from>
          <client_from>
            <id>int</id>
            <client_id>int</client_id>
            <fromEmail>string</fromEmail>
            <zaman>dateTime</zaman>
            <isConfirmed>boolean</isConfirmed>
            <fromName>string</fromName>
          </client_from>
        </returnedEmails>
      </GetFromEmailsResult>
    </GetFromEmailsResponse>
  </soap:Body>
</soap:Envelope>