List unsubscribers

The ListUnsubscribers method retrieves a list of contacts that unsubscribed after a given dateTime.

Guidance Notes

Please note: the API method below is deprecated in favour of the ListSuppressedContacts method. Alternatively, we recommend moving to version 2.0 beta of the API as it contains the most recent functionality (available in both SOAP and REST).

It should be noted that the ListSuppressedContacts method can only be used to retrieve up to 1000 records.

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 date from which you wish to query.	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/ListUnsubscribers"

Example of use in C# .NET

/// <summary>
/// This method should be used to get a list of contacts in your dotMailer 
/// account who have unsubscribed after a specified date. 
/// </summary>
public void ListUnsubscribers()
{
    const string username = "apiuser-XXXXXXXXXXXX@apiconnector.com";
    const string password = "password";
 
    Console.WriteLine("ListUnsubscribers");
    Console.WriteLine("-----------------");
 
    // Get an instance to the web reference
    com.apiconnector.API api = new com.apiconnector.API();
 
    try
    {
        // we are interested in the unsubscribers for the last 30 days
        DateTime startDate = DateTime.Now - new TimeSpan(30, 0, 0, 0);
 
        com.apiconnector.APIContact[] contacts = api.ListUnsubscribers(username, password, startDate);
 
        // did we get data back - if so, 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);
 
                // write out blank line, so the output is easier to read
                Console.WriteLine();
            }
        }
    }
    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/ListUnsubscribers"
<?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>
    <ListUnsubscribers xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <startDate>dateTime</startDate>
    </ListUnsubscribers>
  </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>
    <ListUnsubscribersResponse xmlns="http://apiconnector.com">
      <ListUnsubscribersResult>
        <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>
      </ListUnsubscribersResult>
    </ListUnsubscribersResponse>
  </soap:Body>
</soap:Envelope>

About the API

Address books

Contacts

Campaigns

Reporting

SMS

Account

Images

Documents

Templates