This guide will walk you through the process of exporting selected contacts to downloadable file using the NodeJS library.
Required Access Level: Export
When using Elastic Email, you send emails to contacts – recipients who receive your emails. Contacts can be grouped by created segments or lists.
It's NodeJS code, so make sure you have it installed or download it here: https://nodejs.org/en/download/
Create a new JavaScript file snippet.js
and open it in editor of your preference eg. Visual Studio Code (https://code.visualstudio.com/)
Put the below code to your file.
Load library using below line:
const ElasticEmail = require('@elasticemail/elasticemail-client');
Get client instance:
const client = ElasticEmail.ApiClient.instance;
Generate and use your API key (remember to check a required access level):
const apikey = client.authentications['apikey'];
apikey.apiKey = "YOUR_API_KEY";
In this example we will export contacts to a CSV file.
Create an instance of ContactsApi that will be used to export contacts.
const contactsApi = new ElasticEmail.ContactsApi();
Create an options object:
- fileFormat - specify format in which file should be created, options are: "Csv" "Xml" "Json".
- emails - select contacts to export by providing array of emails
- fileName - you can specify file name of your choice
Other options:
- rule - eg.
rule=Status%20=%20Engaged
– Query used for filtering - compressionFormat - "None" "Zip"
Find out more by checking our API's documentation: https://elasticemail.com/developers/api-documentation/rest-api#operation/contactsExportPost
const options = {
fileFormat: 'Csv',
emails: ["johnsmith@domain.com"],
fileName: 'exported.csv'
};
Create a callback function that will be called when response comes back.
In case of error it will display error details, otherwise it will display a success messages and link to a file.
const callback = (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
console.log('Contacts exported');
console.log('Link', data.Link);
}
};
And finally, call contactsExportPost
method from the API to export contacts:
contactsApi.contactsExportPost(options, callback);
const ElasticEmail = require('@elasticemail/elasticemail-client');
const client = ElasticEmail.ApiClient.instance;
const apikey = client.authentications['apikey'];
apikey.apiKey = "YOUR_API_KEY";
const contactsApi = new ElasticEmail.ContactsApi()
const options = {
fileFormat: 'Csv',
emails: ["johnsmith@domain.com"],
fileName: 'exported.csv'
};
const callback = (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
console.log('Contacts exported');
console.log('Link', data.Link);
}
};
contactsApi.contactsExportPost(options, callback);
node snippet.js