Get contact by email

The GetContactByEmail method retrieves the data for an existing contact in the dotMailer account using their email address.

Guidance Notes

This method can return contacts who are now suppressed in your account; please note that suppressed contacts cannot be sent to.

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
email	string	This is the email address of the contact which you wish to retrieve.	required

Return values

contact

This is the contact object for the email address provided.

Error responses

ERROR_CONTACT_NOT_FOUND
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/GetContactByEmail"

Example of use in C# .NET

/// <summary>
/// This method is used to get a contact in your dotMailer account using 
/// the contact's email address. 
/// </summary>
public void GetContactByEmail()
{
    const string username = "apiuser-XXXXXXXXXXXX@apiconnector.com";
    const string password = "password";
 
    Console.WriteLine("GetContactByEmail");
    Console.WriteLine("-----------------");
 
    // Get an instance to the web reference
    com.apiconnector.API api = new com.apiconnector.API();
 
    try
    {
        // search for the contact that matches the email address via the web service
        com.apiconnector.APIContact contact = api.GetContactByEmail(username, password, "joe.smith@somecompany.com");
 
        // did we get anything back
        if (contact != null)
        {
            // output the contact information
            Console.WriteLine("Contact ID: {0}",  contact.ID);
            Console.WriteLine("Contact Email: {0}",  contact.Email);
            Console.WriteLine("Contact AudienceType: {0}",  contact.AudienceType.ToString());
            Console.WriteLine("Contact EmailType: {0}",  contact.EmailType.ToString());
            Console.WriteLine("Contact Notes: {0}",  contact.Notes);
            Console.WriteLine("Contact OptInType: {0}",  contact.OptInType.ToString());
 
            //
            // if we have some data fields and if they have data, then output 
            // them
            //
            if (contact.DataFields != null &&
                contact.DataFields.Keys != null &&
                contact.DataFields.Values != null &&
                contact.DataFields.Keys.Length > 0 &&
                contact.DataFields.Values.Length > 0 &&
                contact.DataFields.Keys.Length == contact.DataFields.Values.Length)
            {
                for (int i = 0; i < contact.DataFields.Keys.Length; i++)
                {
                    Console.WriteLine("Contact dataField {0} , {1}", contact.DataFields.Keys[i], contact.DataFields.Values[i]);
                }
            }
        }
    }
    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/GetContactByEmail"
<?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>
    <GetContactByEmail xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <email>string</email>
    </GetContactByEmail>
  </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>
    <GetContactByEmailResponse xmlns="http://apiconnector.com">
      <GetContactByEmailResult>
        <ID>int</ID>
        <Email>string</Email>
        <AudienceType>Unknown or B2C or B2B or B2M</AudienceType>
        <DataFields>
          <Keys>
            <string>string</string>
            <string>string</string>
          </Keys>
          <Values>
            <anyType />
            <anyType />
          </Values>
        </DataFields>
        <OptInType>Unknown or Single or Double or VerifiedDouble</OptInType>
        <EmailType>PlainText or Html</EmailType>
        <Notes>string</Notes>
      </GetContactByEmailResult>
    </GetContactByEmailResponse>
  </soap:Body>
</soap:Envelope>

Prebuilt integrations

More about API

Address books

Contacts

Campaigns

Reporting

SMS

Account

Images

Documents

Templates

Get contact by email

The GetContactByEmail method retrieves the data for an existing contact in the dotMailer account using their email address.

Guidance Notes

Parameters

Return values

Error responses

Request

Example of use in C# .NET

Sample request

Sample response

Get started with dotMailer: