Managing Contacts and Lists

Contact List Management

Our contact and list features of Elastic Email can be used directly through the Account interface we provide. Alternatively you can call our REST API and manage your contacts and lists. Below are the API calls we support for contact and list management with details on how to use each call.

Create New Contact

https://api.elasticemail.com/lists/create-contact

Creates a new contact and optionally adds it to the list provided.

Mandatory Parameters:

username = username found on the Setup tab
api_key = your api key found on the Setup tab
email - email address of contact/recipient

Optional Parameters:

listname = the name of the list or lists (separated by semi-colon) the contact will be added to - if blank, it will just create the contact. If the list does not exist it will raise an error and fail
firstname = first name of the contact
lastname = last name of the contact
birthdate = date of birth of the contact
city = city of the contact
country = country of the contact
gender = male or female
organizationname = organization name the contact works for
phone = phone number for the contact
title = the title for the contact (Mr., Mrs, Miss, etc)
state = the state or province for the contact
postalcode = the zip or postal code of the contact

Example

https://api.elasticemail.com/lists/create-contact?username=your_user_name&api_key=your_api_key&email=example@example.com&listname=list_name

Delete Existing Contact

https://api.elasticemail.com/lists/delete-contact

Deletes an existing contact and removes it from ALL lists.

Mandatory Parameters:

username = username found on the Setup tab
api_key = your api key found on the Setup tab
email = email address of contact/recipient (separate by semi-colon to remove multiple)

Example

https://api.elasticemail.com/lists/delete-contact?username=your_user_name&api_key=your_api_key&email=email_address

Create New List

https://api.elasticemail.com/lists/create-list

Creates a new list.

Mandatory Parameters:

username = username found on the Setup tab
api_key = your api key found on the Setup tab
listname = name of list you wish to create

Example

https://api.elasticemail.com/lists/create-list?username=your_user_name&api_key=your_api_key&listname=new_list_name

Delete Existing List

https://api.elasticemail.com/lists/delete

Deletes an existing list. Note that contacts from this list will not be deleted from the system.

Mandatory Parameters:

username = username found on the Setup tab
api_key = your api key found on the Setup tab
listname = name of list you wish to delete

Example

https://api.elasticemail.com/lists/delete?username=your_user_name&api_key=your_api_key&listname=list_name

Add Existing Contact To List

https://api.elasticemail.com/lists/add-contact

Adds an existing contact to an existing list. If the contact or list does not exist an error will result.

Mandatory Parameters:

username = username found on the Setup tab
api_key = your api key found on the Setup tab
email = email address of contact/recipient (separate by semi-colon to add multiple contacts)
listname = name of list you wish to add contact to (separate by semi-colon to add to multiple lists)

Example

https://api.elasticemail.com/lists/add-contact?username=your_user_name&api_key=your_api_key&email=email_address&listname=list_name

Remove Existing Contact From List

https://api.elasticemail.com/lists/remove-contact

Removes an existing contact from an existing list. If the contact or list does not exist an error will result.

Mandatory Parameters:

username = username found on the Setup tab
api_key = your api key found on the Setup tab
email = email address of contact/recipient (separate by semi-colon to remove multiple contacts)
listname = name of list you wish to remove contact from (separate by semi-colon to remove from multiple lists)

Example

https://api.elasticemail.com/lists/remove-contact?username=your_user_name&api_key=your_api_key&email=email_address&listname=list_name

Create Multiple Contacts From CSV File

https://api.elasticemail.com/lists/upload-contacts

Creates new contacts from a CSV file and optionally adds it to the list provided.

Mandatory Parameters:

username = username found on the Setup tab
api_key = your api key found on the Setup tab

Optional Parameters:

listname = the name of the list or lists (separated by semi-colon) the contact will be added to - if blank, it will just create the contact. If the list does not exist it will raise an error and fail

Mandatory Column Names:

email = email address of contact/recipient

Optional Column Names:

firstname = first name of the contact
lastname = last name of the contact
birthdate = date of birth of the contact
city = city of the contact
country = country of the contact
gender = male or female
organizationname = organization name the contact works for
phone = phone number for the contact
title = the title for the contact (Mr., Mrs, Miss, etc)
state = the state or province for the contact
postalcode = the zip or postal code of the contact

Example (C#)

WebClient client = new WebClient();
NameValueCollection params = new NameValueCollection();
params.add(“username”, your_username);
params.add(“api_key”, your_api_key);
params.add(“listname”, "optional_list_name");
client.QueryString = params;
client.UploadFile(“https://api.elasticemail.com/lists/contact/upload-contacts” ,”local_path_to_file”);

Return All Lists

https://api.elasticemail.com/lists/get

Returns all the lists for your account and how many users are in each list.

Mandatory Parameters:

username = username found on the Setup tab
api_key = your api key found on the Setup tab

Example

https://api.elasticemail.com/lists/get?username=your_user_name&api_key=your_api_key

Return All Contacts From List

https://api.elasticemail.com/lists/get-contacts

Returns email, firstname and lastname for an existing list.

Mandatory Parameters:

username = username found on the Setup tab
api_key = your api key found on the Setup tab
listname = name of list you wish to get the contacts for

Example

https://api.elasticemail.com/lists/get-contacts?username=your_user_name&api_key=your_api_key&listname=list_name

Download XML/CSV File Of Contacts

https://api.elasticemail.com/lists/download

Download an XML or CSV file of your list contacts or all contacts.

Mandatory Parameters:

username = username found on the Setup tab
api_key = your api key found on the Setup tab

Optional Parameters:

format = file format of csv or xml - default if not set is xml
compress = true or false, if true the file is compressed to a zip file - default is false
listname = the name of the list to return contacts to, if not set file contains all contacts
firstname = true or false to return
lastname = true or false to return
birthdate = true or false to return
city = true or false to return
country = true or false to return
gender = true or false to return
organizationname = true or false to return
phone = true or false to return
title = true or false to return
state = true or false to return
postalcode = true or false to return

Contact List Management

Create New Contact

Delete Existing Contact

Create New List

Delete Existing List

Add Existing Contact To List

Remove Existing Contact From List

Create Multiple Contacts From CSV File

Return All Lists

Return All Contacts From List

Download XML/CSV File Of Contacts

Elastic Email

Resources

Support

Social