Email Contacts

This page lists the optional parameters, request data and reponse in xml

Retrieve contacts [HTTP GET]

https://appapi.dlangemobile.com/xml/emailcontacts/{api_key}

URL Parameters

• api_key (Required) - Your API application key.

Response Notes

• ID - Used to update, delete and get contact groups

Example XML Response

<EmailContacts>
  <EmailContact>
    <ID>1</ID>
    <EmailAddress>contact1@domain.com</EmailAddress>
    <FirstName>Test</FirstName>
    <LastName>Contact 1</LastName>
    <OptedOut>false</OptedOut>
  </EmailContact>
  <EmailContact>
    <ID>2</ID>
    <EmailAddress>contact2@domain.com</EmailAddress>
    <FirstName>Test</FirstName>
    <LastName>Contact 2</LastName>
    <OptedOut>false</OptedOut>
  </EmailContact>
</EmailContacts>

Error Codes

• 001 - API key is required.
• 002 - Invalid API key.

Retrieve contacts filtered by email address [HTTP POST]

https://appapi.dlangemobile.com/xml/emailcontacts/{api_key}/filterbyemail

URL Parameters

• api_key (Required) - Your API application key.

Request Notes

• EmailAddress - list of email addresses.

Example XML Request

<ArrayOfString>
  <string>contact1@domain.com</string>
  <string>contact2@domain.com</string>
</ArrayOfString>

Response Notes

• ID - Used to update, delete and get contact groups

Example XML Response

<EmailContacts>
  <EmailContact>
    <ID>1</ID>
    <EmailAddress>contact1@domain.com</EmailAddress>
    <FirstName>Test</FirstName>
    <LastName>Contact 1</LastName>
    <OptedOut>false</OptedOut>
  </EmailContact>
  <EmailContact>
    <ID>2</ID>
    <PhoneNumber>contact2@domain.com</PhoneNumber>
    <FirstName>Test</FirstName>
    <LastName>Contact 2</LastName>
    <OptedOut>false</OptedOut>
  </EmailContact>
</EmailContacts>

Error Codes

• 001 - API key is required.
• 002 - Invalid API key.

Add new contact [HTTP POST]

https://appapi.dlangemobile.com/xml/emailcontacts/{api_key}

URL Parameters

• api_key (Required) - Your API application key.

Request Notes

• EmailAddress - Contact email address.
• FirstName - Contact first name. Max number of characters is 50.
• FirstName - Contact first name. Max number of characters is 50.

Example XML Request

<EmailContact>
  <EmailAddress>contact1@domain.com</EmailAddress>
  <FirstName>New</FirstName>
  <LastName>Contact</LastName>
</EmailContact>

Response Notes

• ID - Automatically-assigned ID used to update, delete and get contact groups

Example XML Response

<EmailContact>
  <ID>1</ID>
  <EmailAddress>contact2@domain.com</EmailAddress>
  <FirstName>New</FirstName>
  <LastName>Contact</LastName>
</EmailContact>

Error Codes

• 001 - API key is required.
• 002 - Invalid API key.
• 110 - Provide a valid contact info. Request XML is invalid or not passed as post data.
• 104 - Provide a email address.
• 105 - Invalid invalid email address.
• 106 - Invalid first name. Max number of characters allowed is 50.
• 107 - Invalid last name. Max number of characters allowed is 50.
• 108 - Email address already exists. App does not accept duplicate email addresses.

Opt-in Email Contact [HTTP GET]

https://appapi.dlangemobile.com/xml/emailcontacts/{api_key}/optinemail?emailaddress={email_address}

URL Parameters

• api_key (Required) - Your API application key.
• email_address (Required) - Existing email address that you want to opt back in.

Response Notes

Returns 'Success' if opt-in is successful.

Error Codes

• 001 - API key is required.
• 002 - Invalid API key.
• 104 - Provide a email address.
• 112 - Email Address does not exist.