List address books

The ListAddressBooks method lists all the available address books within the your dotMailer account.

This will return the ID numbers of the address books which you will need for other API methods.

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

Return values

Address Books

array

An array of APIAddressBook objects; each consisting of an ID (integer) and a name (string).

Error responses

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/ListAddressBooks"

Example of use in C# .NET

/// <summary>
/// This method will list all the available address books within the dotMailer account you're connected to.
/// </summary>
public void ListAddressBooks()
{
    const string username = "apiuser-XXXXXXXXXXXX@apiconnector.com";
    const string password = "password";
 
    Console.WriteLine("ListAddressBooks");
    Console.WriteLine("----------------");
 
    // Get an instance to the web reference
    com.apiconnector.API api = new com.apiconnector.API();
 
    try
    {
        // List the address books
        com.apiconnector.APIAddressBook[] books = api.ListAddressBooks(username, password);
 
        // make sure we were given some address books
        if (books != null && books.Length > 0)
        {
            // go through the returned address books, and printout their
            // information
            foreach (com.apiconnector.APIAddressBook addrBook in books)
            {
                Console.WriteLine("ID: {0}", addrBook.ID);
                Console.WriteLine("Name: {0}", addrBook.Name);
 
                // write out blank line, so the output is easier to read
                Console.WriteLine();
            }
        }
        else
        {
            Console.WriteLine("No Address Books");
        }
    }
    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/ListAddressBooks"
<?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>
    <ListAddressBooks xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
    </ListAddressBooks>
  </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>
    <ListAddressBooksResponse xmlns="http://apiconnector.com">
      <ListAddressBooksResult>
        <APIAddressBook>
          <ID>int</ID>
          <Name>string</Name>
        </APIAddressBook>
        <APIAddressBook>
          <ID>int</ID>
          <Name>string</Name>
        </APIAddressBook>
      </ListAddressBooksResult>
    </ListAddressBooksResponse>
  </soap:Body>
</soap:Envelope>

Prebuilt integrations

More about API

Address books

Contacts

Campaigns

Reporting

SMS

Account

Images

Documents

Templates