sendy-api-node
v0.5.2
Published
Sendy API for Node.js
Downloads
100
Maintainers
Readme
Sendy API for Node.js
Installation
Run the following command in your project.
npm i sendy-api-node
Examples
First of all add this.
var Sendy = require('sendy-api'),
sendy = new Sendy('http://your_sendy_installation/', 'your_api_key');
API
subscribe
var params = {
email: '[email protected]',
list_id: 'your_list_id'
}
sendy.subscribe(params, function(err, result) {
if (err) console.log(err.toString());
else console.log('Subscribed succesfully');
});
unsubscribe
var params = {
email: '[email protected]',
list_id: 'your_list_id'
}
sendy.unsubscribe(params, function(err, result) {
if (err) console.log(err.toString());
else console.log('Unsubscribed succesfully);
});
status
var params = {
email: '[email protected]',
list_id: 'your_list_id'
}
sendy.status(params, function(err, result) {
if (err) console.log(err.toString());
else console.log('Status: ' + result);
});
countActive
var params = {
list_id: 'your_list_id'
}
sendy.countActive(params, function(err, result) {
if (err) console.log(err.toString());
else console.log('Active subscribers: ' + result);
});
createCampaign
var params = {
from_name: 'Your name',
from_email: '[email protected]',
reply_to: '[email protected]',
subject: 'Your Subject',
plain_text: 'Campaign text' // Optional.
html_text: '<h1>Campaign text</h1>',
send_campaign: 0 // Set to 0 if you just want to create a draft campaign — 1 if you want to create and send.
list_ids: 'your_list_id' // seperate multiple lists with a comma. Only required if send_campaign parameter is true.
brand_id: 'your_brand_id' // only required if send_campaign parameter is false. Check url what is, i=X that x is the brand ID.
};
sendy.createCampaign(params, function(err,result){
if (err) console.log(err.toString());
else console.log(result);
});
License & Attribution
Licensed as MIT ⓒ Ahmad Awais — based on the initial fork of Igor Dimitrijevic's work.