sendy-api
v0.1.0
Published
sendy api for node
Downloads
210
Readme
sendy-api
node.js module for Sendy API - [http://sendy.co/api] (http://sendy.co/api)
Example:
var Sendy = require('sendy-api'),
sendy = new Sendy('http://your_sendy_installation/', 'your_api_key');
sendy.subscribe({email: "[email protected]", list_id: 'your_list_id'}, function(err, result) {
if (err) console.log(err.toString());
else console.log('Success: ' + result);
});
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: 'true' // optional, set to false if you just want to create a draft campaign
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
};
sendy.createCampaign(params, function(err,result){
if (err) console.log(err.toString());
else console.log(result);
});