List modified contacts in address book

The ListModifiedContactsInAddressBook method is obsolete please use ListModifiedContactsInAddressBook2.

This method retrieved a list of contacts in a specified address book who were modified between two specified dates.

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
startDate	dateTime	The start date for the period you wish to query.	required
endDate	dateTime	The end date for the period you wish to query.	required
addressBookId	int	The ID of the address book in dotMailer that you wish to select contacts from.	required

Return values

The result is an array of contact objects.

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

Example of use in C# .NET

/// <summary>
/// This method lets you get a list of modified contacts from an address 
/// book between a specified date range. 
/// 
/// This method has been superseded by ListModifiedContactsInAddressBook2
/// </summary>
public void ListModifiedContactsInAddressBook()
{
    const string username = "apiuser-XXXXXXXXXXXX@apiconnector.com";
    const string password = "password";
    const int addressBookId = 1;
 
    Console.WriteLine("ListModifiedContactsInAddressBook");
    Console.WriteLine("---------------------------------");
 
    // Get an instance to the web reference
    com.apiconnector.API api = new com.apiconnector.API();
 
    try
    {
        DateTime endDate = DateTime.Now;
        DateTime startDate = endDate - new TimeSpan(30, 0, 0, 0);
 
        // get the list of modified contacts from the web service
        com.apiconnector.APIContact[] contacts = api.ListModifiedContactsInAddressBook(username, password, startDate, endDate, addressBookId);
 
        // if we received any data, we should display it
        if (contacts != null && contacts.Length > 0)
        {
            foreach (com.apiconnector.APIContact contact in contacts)
            {
                Console.WriteLine("AudienceType : {0}", contact.AudienceType);
                Console.WriteLine("Email : {0}", contact.Email);
                Console.WriteLine("EmailType : {0}", contact.EmailType);
                Console.WriteLine("ID : {0}", contact.ID);
                Console.WriteLine("Notes : {0}", contact.Notes);
                Console.WriteLine("OptInType : {0}", contact.OptInType);
                Console.WriteLine();
            }
        }
        else
        {
            Console.WriteLine("No Modified contacts between {0} - {1}", startDate.ToShortDateString(), endDate.ToShortDateString());
        }
    }
    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/ListModifiedContactsInAddressBook"
<?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>
    <ListModifiedContactsInAddressBook xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <startDate>dateTime</startDate>
      <endDate>dateTime</endDate>
      <addressBookID>int</addressBookID>
    </ListModifiedContactsInAddressBook>
  </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>
    <ListModifiedContactsInAddressBookResponse xmlns="http://apiconnector.com">
      <ListModifiedContactsInAddressBookResult>
        <APIContact>
          <ID>int</ID>
          <Email>string</Email>
          <AudienceType>Unknown or B2C or B2B or B2M</AudienceType>
          <DataFields>
            <Keys xsi:nil="true" />
            <Values xsi:nil="true" />
          </DataFields>
          <OptInType>Unknown or Single or Double or VerifiedDouble</OptInType>
          <EmailType>PlainText or Html</EmailType>
          <Notes>string</Notes>
        </APIContact>
        <APIContact>
          <ID>int</ID>
          <Email>string</Email>
          <AudienceType>Unknown or B2C or B2B or B2M</AudienceType>
          <DataFields>
            <Keys xsi:nil="true" />
            <Values xsi:nil="true" />
          </DataFields>
          <OptInType>Unknown or Single or Double or VerifiedDouble</OptInType>
          <EmailType>PlainText or Html</EmailType>
          <Notes>string</Notes>
        </APIContact>
      </ListModifiedContactsInAddressBookResult>
    </ListModifiedContactsInAddressBookResponse>
  </soap:Body>
</soap:Envelope>

About the API

Address books

Contacts

Campaigns

Reporting

SMS

Account

Images

Documents

Templates

List modified contacts in address book

The ListModifiedContactsInAddressBook method is obsolete please use ListModifiedContactsInAddressBook2.

Parameters

Return values

Error responses

Request

Example of use in C# .NET

Sample request

Sample response

Get started with dotMailer: