List campaigns for address book

The ListCampaignsForAddressBook method retrieves a filtered list of campaigns that have been sent to the specified address book. This can be useful in ensuring that you do not send the same campaign to the same contacts.

Guidance Notes

Remember that the filter is based on the address book so if the contacts in the address book are changed it will show the address book as still having been sent the campaign even though the contacts within might not have received that particular campaign.

Parameters

username	string	This is the username from your API key. It is in the format of an email address and will look similar to apiuser‑908709770324@apiconnector.com	required
password	string	This is the password from your API key.	required
addressBookId	int	This is the Id of the AddressBook in your dotMailer account that you wish to query against.	required

Return values

The result is an array of APICampaign objects, each consisting of the following:

fromName	string	The name the email will be set to be from.
htmlContent	string	The contents of the HTML campaign.
id	int	The campaign ID.
name	string	The name of the campaign.
plaintextContent	string	The contents of the Plain Text version of the campaign.
replyAction		Unset or WebMailForward or Webmail or Delete.
replyToAddress		The email address replies should be forwarded to.
status		NotSet or Unsent or Sending or Sent or Paused or Cancelled or RequiresApproval or Requires SMSApproval or Triggered.
subject	string	The subject line of the email.

Error responses

ERROR_ADDRESSBOOK_NOT_FOUND
ERROR_APIUSAGE_EXCEEDED
ERROR_INVALID_LOGIN
ERROR_PARAMETER_INVALID
ERROR_SYSTEM_SERVICETEMPORARILYUNAVAILABLE
ERROR_UNKNOWN

Request

POST /API.asmx HTTP/1.1
Host: apiconnector.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://apiconnector.com/ListCampaignsForAddressBook"

Example of use in C# .NET

/// <summary>
/// This method will list any campaigns that you have sent to specified address book. 
/// </summary>
public void ListCampaignsForAddressBook()
{
    const string username = "apiuser-XXXXXXXXXXXX@apiconnector.com";
    const string password = "password";
    const int addressBookId = 1;
 
    Console.WriteLine("ListCampaignsForAddressBook");
    Console.WriteLine("---------------------------");
 
    // Get an instance to the web reference
    com.apiconnector.API api = new com.apiconnector.API();
 
    try
    {
        // get the list of campaigns from the web service
        com.apiconnector.APICampaign[] campaigns = api.ListCampaignsForAddressBook(username, password, addressBookId);
 
        if (campaigns != null && campaigns.Length > 0)
        {
            foreach (com.apiconnector.APICampaign campaign in campaigns)
            {
                Console.WriteLine("Campaign: {0}", campaign.Id);
                Console.WriteLine("FromName: {0}", campaign.FromName);
                Console.WriteLine("Name: {0}", campaign.Name);
                Console.WriteLine("ReplyAction: {0}", campaign.ReplyAction.ToString());
                Console.WriteLine("ReplyToAddress: {0}", campaign.ReplyToAddress);
                Console.WriteLine("Status: {0}", campaign.Status.ToString());
                Console.WriteLine("Subject: {0}", campaign.Subject);
 
                //
                // * ListCampaigns doesn't return the content of the campaign, so the following
                // fields will contain no data, and can be ignored. Use GetCampaign() to retrieve this
                // information
                //
                //Console.WriteLine("HTMLContent: {0}", campaign.HTMLContent);
                //Console.WriteLine("PlaintextContent: {0}", campaign.PlaintextContent);
 
                // write out blank line, so the output is easier to read
                Console.WriteLine();
            }
        }
        else
        {
            Console.WriteLine("There are no campaigns for the address book {0}", addressBookId);
        }
    }
    catch (SoapException ex)  // catch any soap issues/errors from the web service
    {
        Console.WriteLine("Error -> {0}", ex.Message);
    }
 
    Console.WriteLine();
}

Sample request

POST /API.asmx HTTP/1.1
Host: apiconnector.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://apiconnector.com/ListCampaignsForAddressBook"
<?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>
    <ListCampaignsForAddressBook xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <addressBookID>int</addressBookID>
    </ListCampaignsForAddressBook>
  </soap:Body>
</soap:Envelope>

Sample response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?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>
    <ListCampaignsForAddressBookResponse xmlns="http://apiconnector.com">
      <ListCampaignsForAddressBookResult>
        <APICampaign>
          <FromName>string</FromName>
          <HTMLContent>string</HTMLContent>
          <Id>int</Id>
          <Name>string</Name>
          <PlaintextContent>string</PlaintextContent>
          <ReplyAction>Unset or WebMailForward or Webmail or Delete</ReplyAction>
          <ReplyToAddress>string</ReplyToAddress>
          <Status>NotSet or Unsent or Sending or Sent or Paused or Cancelled or RequiresApproval or RequiresSMSApproval or Triggered</Status>
          <Subject>string</Subject>
        </APICampaign>
        <APICampaign>
          <FromName>string</FromName>
          <HTMLContent>string</HTMLContent>
          <Id>int</Id>
          <Name>string</Name>
          <PlaintextContent>string</PlaintextContent>
          <ReplyAction>Unset or WebMailForward or Webmail or Delete</ReplyAction>
          <ReplyToAddress>string</ReplyToAddress>
          <Status>NotSet or Unsent or Sending or Sent or Paused or Cancelled or RequiresApproval or RequiresSMSApproval or Triggered</Status>
          <Subject>string</Subject>
        </APICampaign>
      </ListCampaignsForAddressBookResult>
    </ListCampaignsForAddressBookResponse>
  </soap:Body>
</soap:Envelope>

Prebuilt integrations

More about API

Address books

Contacts

Campaigns

Reporting

SMS

Account

Images

Documents

Templates