@nowmedia-team/unisender
v1.1.1
Published
Promise-based wrapper for unisender api
Downloads
13
Maintainers
Readme
node-unisender
Promise-based wrapper for UniSender API. Sends POST request to UniSender.
List of available in module methods is in src/config/methods.js.
Installation
npm install unisender
Usage
You can send request to unisender API via calling function of unisender object with appropriate name:
unisender.<method name>(options);
for example
var UniSender = require('unisender');
var uniSender = new UniSender({
api_key: 'YOUR_API_KEY',
lang: 'ru' // optional, 'en' by default
});
uniSender.getLists().then(console.log);
uniSender.createEmailMessage({
sender_name: 'Test',
sender_email: '[email protected]',
subject: 'hello',
body: '<h1>Hello world!</h1>',
list_id: 1234567
}).then(function (response) {
console.log('Message id: ' + response.result.message_id);
}).catch(function (response) {
console.log('Error:' + response.error);
});
Full list of UniSender methods and options you can find in UniSender API Documentation.
Note
For all methods except importContacts
you have to pass parameters as described in UniSender API Documentation.
To call importContacts
specify properties field_names
and data
in another way:
uniSender.importContacts({
field_names: ['email', 'email_list_ids'],
data: [
{ email: '[email protected]', email_list_ids: '1, 2, 3' },
{ email: '[email protected]', email_list_ids: '1' },
{ email: '[email protected]', email_list_ids: '3' },
]
});
They'll be transformed into
field_names[0]=email&field_names[1]=email_list_ids
&data[0][0][email protected]&data[0][1]=1,2,3
&data[1][0][email protected]&data[1][1]=1
&data[2][0][email protected]&data[2][1]=3