GetUnsubscribedContactsInAddressBook

Gets a list of contacts who have unsubscribed since a given date from a given address book

This method can be used to get a list of contacts who have unsubscribed from a particular address book in your account after a given date.

Please note that this method doesn't return contacts who have unsubscribed from the whole account. To get a list of account unsubscribers, please use GetUnsubscribedContacts.

The select parameter requires a number between 1 and 1000 (0 is not a valid number). You may only select a maximum of 1000 results in a single request.

The skip parameter should be used in tandem with the select parameter when wanting to iterate through a whole data set. If you want to select the next 1000 records you should set the select parameter to 1000 and the skip parameter to 1000, which will return records 1001 to 2000. You should continue to do this until 0 records are returned to retrieve the whole data set.

SOAP action: http://apiconnector.com/v2/ApiService/GetUnsubscribedContactsInAddressBook

πŸ“˜

Input and output parameters

Input parameters

  • AddressBook ID - required; integer
  • StartDate - required; dateTime
  • Select - optional; integer
  • Skip - optional; integer

Output parameters

  • GetUnsubscribedContactsInAddressBookResult - array of ContactSuppression
    • ContactSuppression
      • SuppressedContact
        • Id - integer
        • Email - string
        • OptInType - string ('Unknown', 'Single', 'Double', 'VerifiedDouble')
        • EmailType - string ('PlainText', 'Html')
        • DataFields - optional; array of ContactData
          • ContactData
            • Key - string
            • Value - anyType
        • Status - string ('Subscribed', 'Unsubscribed', 'SoftBounced', 'HardBounced', 'IspComplained', 'MailBlocked', 'PendingOptIn', 'DirectComplaint', 'Deleted', 'SharedSuppression', 'Suppressed', 'NotAllowed', 'DomainSuppression', 'NoMxRecord')
      • DateRemoved - dateTime
      • Reason - string ('Subscribed', 'Unsubscribed', 'SoftBounced', 'HardBounced', 'IspComplained', 'MailBlocked', 'PendingOptIn', 'DirectComplaint', 'Deleted', 'SharedSuppression', 'Suppressed', 'NotAllowed', 'DomainSuppression', 'NoMxRecord')

Example

using (var client = new ApiServiceClient())
{
	client.ClientCredentials.UserName.UserName = "username";
	client.ClientCredentials.UserName.Password = "password";

	var startDate = new DateTime(2020, 01, 01, 00, 00, 00, DateTimeKind.Utc);
	var select = 1000;
	var skip = 0;
	var addressBookId = 1;
	var unsubscribedContacts = client.GetUnsubscribedContactsInAddressBook(addressBookId, startDate, select, skip);
}