Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

sendy-api-node

Package Overview
Dependencies
Maintainers
1
Versions
6
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

sendy-api-node

Sendy API for Node.js

  • 0.5.2
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
19
increased by11.76%
Maintainers
1
Weekly downloads
 
Created
Source

Sendy API for Node.js


Sendy API Node.js
Node.js module for [Sendy API](http://sendy.co/api).
A FOSS (Free & Open Source Software) project developed by Ahmad Awais.
Follow Ahmad's #FOSS work on GitHub @AhmadAwais — Say Hi on Twitter @MrAhmadAwais👋

GitHub stars GitHub followers Tweet for help


Install

Installation

Run the following command in your project.

npm i sendy-api-node

Example

Examples

First of all add this.

var Sendy = require('sendy-api'),
    sendy = new Sendy('http://your_sendy_installation/', 'your_api_key');

Example

API

subscribe
var params = {
    email: 'user@example.com',
    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: 'user@example.com',
    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: 'user@example.com',
    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@example.com',
    reply_to: 'email@example.com',
    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

License & Attribution

Licensed as MIT ⓒ Ahmad Awais — based on the initial fork of Igor Dimitrijevic's work.

Keywords

FAQs

Package last updated on 15 Aug 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc