Contact List API

With Our Full Email API, Easily Manage Your Subscribers

AddBulkContact()

Use this method to add a collection of contacts to your contact list.

  • apiKey (Required)

Your application authentication key. To get yours, click here.

  • list_id (Required)

The ID number of the list to which the contact should be added. You can get a list of your contact lists using the GetLists() method.

  • list (of shortContactItem) (Required)

A collection of email addresses, first names and last names of the contacts you’ll be adding. Must be valid email addresses.

On success, this method returns a “success” response (code 0). On failure, an error code with description will be returned.

Method checks if the email addresses exists in the specified contact lists and it won’t allow you to add duplicate emails.


<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>
    <AddBulkContact xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
      <list_id>int</list_id>
      <contacts>
        <shortContactItem>
          <email>string</email>
          <firstname>string</firstname>
          <lastname>string</lastname>
        </shortContactItem>
        <shortContactItem>
          <email>string</email>
          <firstname>string</firstname>
          <lastname>string</lastname>
        </shortContactItem>
      </contacts>
    </AddBulkContact>
  </soap:Body>
</soap:Envelope>


<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>
    <AddBulkContactResponse xmlns="http://api.directiq.com/">
      <AddBulkContactResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
      </AddBulkContactResult>
    </AddBulkContactResponse>
  </soap:Body>
</soap:Envelope>

AddContact()

Use this method to add a contact to your contact list.

  • apiKey (Required)

Your application authentication key. To get yours, click here.

  • list_id (Required)

The ID number of the list to which the contact should be added. You can get a list of your contact lists using the GetLists() method.

  • email (Required)

Email address of the contact you’ll be adding. Must be a valid email address.

  • firstname

First name of the contact you’ll be adding. This field is optional.

  • lastname

Last name of the contact you’ll be adding. This field is optional.

On success, this method returns a “success” response (code 0). On failure, an error code with description will be returned.

Method checks if the email address exists in the specified contact lists and it won’t allow you to add duplicate emails.


<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>
    <AddContact xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
      <email>string</email>
      <firstname>string</firstname>
      <lastname>string</lastname>
      <list_id>int</list_id>
    </AddContact>
  </soap:Body>
</soap:Envelope>


<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>
    <AddContactResponse xmlns="http://api.directiq.com/">
      <AddContactResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
      </AddContactResult>
    </AddContactResponse>
  </soap:Body>
</soap:Envelope>

AddContactToSupressionList()

Use this method to add email addresses to Supression List. Contacts added to the Supression List will not receive emails from you. It’s a no-send list.

  • apiKey (Required)

Your application authentication key. To get yours, click here.

  • email (Required)

On success, this method returns a “success” response (code 0). On failure, an error code with description will be returned.


<?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>
    <AddContactToSupressionList xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
      <email>string</email>
    </AddContactToSupressionList>
  </soap:Body>
</soap:Envelope>


<?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>
    <AddContactToSupressionListResponse xmlns="http://api.directiq.com/">
      <AddContactToSupressionListResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
      </AddContactToSupressionListResult>
    </AddContactToSupressionListResponse>
  </soap:Body>
</soap:Envelope>

CreateList()

Use this method to create a new contact list.

  • apiKey (Required)

Your application authentication key. To get yours, click here.

  • list_name (Required)

Name of the contact list to be created.

On success, this method returns a “success” response (code 0). Also unique ID of the newly created list will be provided in list_id field. On failure, an error code with description will be returned.

Method will fail if a contact list with the specified name already exists.


<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>
    <CreateList xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
      <list_name>string</list_name>
    </CreateList>
  </soap:Body>
</soap:Envelope>


<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>
    <CreateListResponse xmlns="http://api.directiq.com/">
      <CreateListResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
        <list_id>int</list_id>
      </CreateListResult>
    </CreateListResponse>
  </soap:Body>
</soap:Envelope>

DeleteContact()

Use this method to delete a contact from your contact list.

  • apiKey (Required)

Your application authentication key. To get yours, click here.

  • list_id (Required)

The ID number of the list which contains the contact to be deleted. You can get a list of your contact lists using the GetLists() method.

  • email (Required)

Email address of the contact you’ll be deleting. Must be a valid email address and exist in the specified contact list.

On success, this method returns a “success” response (code 0). On failure, an error code with description will be returned.


<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>
    <DeleteContact xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
      <email>string</email>
      <list_id>int</listId>
    </DeleteContact>
  </soap:Body>
</soap:Envelope>


<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>
    <DeleteContactResponse xmlns="http://api.directiq.com/">
      <DeleteContactResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
      </DeleteContactResult>
    </DeleteContactResponse>
  </soap:Body>
</soap:Envelope>

DeleteList()

Use this method to delete a contact list.

  • apiKey (Required)

Your application authentication key. To get yours, click here.

  • list_id (Required)

ID of the contact list to be deleted.

On success, this method returns a “success” response (code 0). On failure, an error code with description will be returned.

Method will fail if a contact list with the specified ID does not exist.


<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>
    <DeleteList xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
      <list_id>int</list_id>
    </DeleteList>
  </soap:Body>
</soap:Envelope>


<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>
    <DeleteListResponse xmlns="http://api.directiq.com/">
      <DeleteListResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
      </DeleteListResult>
    </DeleteListResponse>
  </soap:Body>
</soap:Envelope>

GetActiveContacts()

Use this method to get all active contacts in the specified contact list.

  • apiKey (Required)

Your application authentication key. To get yours, click here.

  • list_id (Required)

The ID number of the list to be returned. You can get a list of your contact lists using the GetLists() method.

On success, this method returns a “success” response (code 0). On failure, an error code with description will be returned.

Method will fail if a contact list with the specified ID does not exist.


<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>
    <GetActiveContacts xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
      <list_id>int</list_id>
    </GetActiveContacts>
  </soap:Body>
</soap:Envelope>


<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>
    <GetActiveContactsResponse xmlns="http://api.directiq.com/">
      <GetActiveContactsResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
        <returnedList>
          <contact>
            <user_id>int</user_id>
            <email>string</email>
            <firstname>string</firstname>
            <lastname>string</lastname>
            <status>unsignedByte</status>
            <info>string</info>
            <list_id>int</list_id>
          </contact>
          <contact>
            <user_id>int</user_id>
            <email>string</email>
            <firstname>string</firstname>
            <lastname>string</lastname>
            <status>unsignedByte</status>
            <info>string</info>
            <list_id>int</list_id>
          </contact>
        </returnedList>
      </GetActiveContactsResult>
    </GetActiveContactsResponse>
  </soap:Body>
</soap:Envelope>

GetAllContacts()

Use this method to get all contacts in the specified contact list. Both active and passive contacts will be returned.

  • apiKey (Required)

Your application authentication key. To get yours, click here.

  • list_id (Required)

The ID number of the list to be returned. You can get a list of your contact lists using the GetLists() method.

On success, this method returns a “success” response (code 0). Method also returns a list of contact object which contains ids, emails, first and last names of the contacts. Status field contains status of the contacts (0 passive, 1 active). On failure, an error code with description will be returned.


<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>
    <GetAllContacts xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
      <list_id>int</list_id>
    </GetAllContacts>
  </soap:Body>
</soap:Envelope>


<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>
    <GetAllContactsResponse xmlns="http://api.directiq.com/">
      <GetAllContactsResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
        <returnedList>
          <contact>
            <user_id>int</user_id>
            <email>string</email>
            <firstname>string</firstname>
            <lastname>string</lastname>
            <status>unsignedByte</status>
            <info>string</info>
            <list_id>int</list_id>
          </contact>
          <contact>
            <user_id>int</user_id>
            <email>string</email>
            <firstname>string</firstname>
            <lastname>string</lastname>
            <status>unsignedByte</status>
            <info>string</info>
            <list_id>int</list_id>
          </contact>
        </returnedList>
      </GetAllContactsResult>
    </GetAllContactsResponse>
  </soap:Body>
</soap:Envelope>

GetContact()

Use this method to get a contact’s all information.

  • apiKey (Required)

Your application authentication key. To get yours, click here.

  • list_id (Required)

The ID number of the list to which the contact is in. You can get a list of your contact lists using the GetLists() method.

  • email (Required)

Email address of the contact to query. Must be a valid email address.

On success, this method returns a “success” response (code 0). Method also returns queried contact’s id, email, first and last name and status of the contact. Status field contains status of the contact (0 passive, 1 active). On failure, an error code with description will be returned.


<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>
    <GetContact xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
      <list_id>int</list_id>
      <email>string</email>
    </GetContact>
  </soap:Body>
</soap:Envelope>


<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>
    <GetContactResponse xmlns="http://api.directiq.com/">
      <GetContactResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
        <returnedContact>
          <user_id>int</user_id>
          <email>string</email>
          <firstname>string</firstname>
          <lastname>string</lastname>
          <status>unsignedByte</status>
          <info>string</info>
          <list_id>int</list_id>
        </returnedContact>
      </GetContactResult>
    </GetContactResponse>
  </soap:Body>
</soap:Envelope>

GetContactByID()


<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>
    <GetContactByID xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
      <contactID>int</contactID>
    </GetContactByID>
  </soap:Body>
</soap:Envelope>


<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>
    <GetContactByIDResponse xmlns="http://api.directiq.com/">
      <GetContactByIDResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
        <returnedContact>
          <contactID>int</contactID>
          <email>string</email>
          <firstname>string</firstname>
          <lastname>string</lastname>
          <dateadded>dateTime</dateadded>
          <gender>string</gender>
          <city>string</city>
          <birthdate>string</birthdate>
          <extended1>string</extended1>
          <extended2>string</extended2>
          <extended3>string</extended3>
          <extended4>string</extended4>
          <extended5>string</extended5>
          <extended6>string</extended6>
          <extended7>string</extended7>
          <extended8>string</extended8>
          <extended9>string</extended9>
          <extended10>string</extended10>
          <extended11>string</extended11>
          <extended12>string</extended12>
          <extended13>string</extended13>
          <extended14>string</extended14>
          <extended15>string</extended15>
          <isActive>boolean</isActive>
          <isVisible>boolean</isVisible>
          <canBeReactivated>boolean</canBeReactivated>
        </returnedContact>
      </GetContactByIDResult>
    </GetContactByIDResponse>
  </soap:Body>
</soap:Envelope>

GetLists()

Use this method to get a list of all contact lists.

  • apiKey (Required)

Your application authentication key. To get yours, click here.

On success, this method returns the following information: list_id : unique ID of the list list_name : name of the list list_count : total number of contacts in the list active : count of active contacts in the list passive : count of passive contacts in the list On failure, this method returns an error code and a description.


<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>
    <GetLists xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
    </GetLists>
  </soap:Body>
</soap:Envelope>


<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>
    <GetListsResponse xmlns="http://api.directiq.com/">
      <GetListsResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
        <returnedList>
          <contactList>
            <list_id>int</list_id>
            <list_name>string</list_name>
            <list_lastupdate>dateTime</list_lastupdate>
            <list_count>int</list_count>
            <active>int</active>
            <passive>int</passive>
          </contactList>
          <contactList>
            <list_id>int</list_id>
            <list_name>string</list_name>
            <list_lastupdate>dateTime</list_lastupdate>
            <list_count>int</list_count>
            <active>int</active>
            <passive>int</passive>
          </contactList>
        </returnedList>
      </GetListsResult>
    </GetListsResponse>
  </soap:Body>
</soap:Envelope>

GetPassiveContacts()

Use this method to get all passive contacts in the specified contact list.

  • apiKey (Required)

Your application authentication key. To get yours, click here.

  • list_id (Required)

The ID number of the list to be returned. You can get a list of your contact lists using the GetLists() method.

On success, this method returns a “success” response (code 0). Method also returns a list of contact object which contains ids, emails, first and last names of the contacts. Status field contains status of the contacts (0 passive, 1 active). On failure, an error code with description will be returned.


<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>
    <GetPassiveContacts xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
      <list_id>int</list_id>
    </GetPassiveContacts>
  </soap:Body>
</soap:Envelope>


<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>
    <GetPassiveContactsResponse xmlns="http://api.directiq.com/">
      <GetPassiveContactsResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
        <returnedList>
          <contact>
            <user_id>int</user_id>
            <email>string</email>
            <firstname>string</firstname>
            <lastname>string</lastname>
            <status>unsignedByte</status>
            <info>string</info>
            <list_id>int</list_id>
          </contact>
          <contact>
            <user_id>int</user_id>
            <email>string</email>
            <firstname>string</firstname>
            <lastname>string</lastname>
            <status>unsignedByte</status>
            <info>string</info>
            <list_id>int</list_id>
          </contact>
        </returnedList>
      </GetPassiveContactsResult>
    </GetPassiveContactsResponse>
  </soap:Body>
</soap:Envelope>