Create address book

The CreateAddressBook method creates an address book in your dotMailer account.

This method can be used when you need to create an address book on the fly instead of having to rely on an address book which already exists within the dotMailer system.

Guidance Notes

The name cannot be the name of an already existing address book or one of the reserved address books such as Test or All contacts.

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
book	book	This is an address book object; it includes an ID (integer) and a name (string). Only the name is required as the ID will be automatically generated for you upon creation.	partially required

Return values

book

This is an address book object; it includes the generated ID (integer) and the name (string) provided.

Error responses

ERROR_ADDRESSBOOK_DUPLICATE
ERROR_ADDRESSBOOK_INVALID
ERROR_ADDRESSBOOK_LIMITEXCEEDED
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/CreateAddressBook"

Example of use in C# .NET

/// <summary>
/// Creates an address book in your dotMailer account
/// </summary>
public void CreateAddressBook() 
{
    const string username = "apiuser-XXXXXXXXXXXX@apiconnector.com";
    const string password = "password";
 
    Console.WriteLine("CreateAddressBook");
    Console.WriteLine("-----------------");
 
    // Get an instance to the web reference
    com.apiconnector.API api = new com.apiconnector.API();
 
    try
    {
        // Create a new address book object
        com.apiconnector.APIAddressBook addrBook = new com.apiconnector.APIAddressBook();
 
        // Generate a unique name for the address book. 
        addrBook.Name = "AddressBook " + DateTime.Now.Millisecond.ToString();
 
        // create the address book
        com.apiconnector.APIAddressBook newBook = api.CreateAddressBook(username, password, addrBook);
 
        // Did we get something back from the API ?
        if (newBook != null)
        {
            Console.WriteLine("Address Book Created: {0}", newBook.ID);
        }
    }
    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/CreateAddressBook"
<?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>
    <CreateAddressBook xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <book>
        <ID>int</ID>
        <Name>string</Name>
      </book>
    </CreateAddressBook>
  </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>
    <CreateAddressBookResponse xmlns="http://apiconnector.com">
      <CreateAddressBookResult>
        <ID>int</ID>
        <Name>string</Name>
      </CreateAddressBookResult>
    </CreateAddressBookResponse>
  </soap:Body>
</soap:Envelope>

About the API

Address books

Contacts

Campaigns

Reporting

SMS

Account

Images

Documents

Templates