NickTomlin / mailchimp-lite

A lightweight wrapper for Mailchimp's v2 and v3 apis

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

mailchimp-lite Build Status NPM package Join the chat at https://gitter.im/NickTomlin/mailchimp-lite

A lightweight wrapper for Mailchimp's v2 and v3 apis.

npm i mailchimp-lite --save

Usage

let Mailchimp = require('mailchimp-lite');

let mailchimp = new Mailchimp({
  key: process.env.MAILCHIMP_API_KEY,
  datacenter: MAILCHIMP_DATACENTER
});

// get details on a list
mailchimp
  .get('/list/my-list-id')
  .then((listInstance) => {
    console.log(listInstance);
  });

// delete a list
mailchimp
  .delete('/lists/my-list-id');

// use the v2 api to batch-subscribe (currently not available in V3 api)
return mailchimp.v2.post('/lists/batch-subscribe', {
  id: 'my-list-id'
  update_existing: true,
  double_optin: false,
  replace_interests: false,
  batch: [
    {email: {email: 'freddy@mailchimp.com'}}
  ]
})
.then((response) => { console.log(response); })

Error Handling

Responses with a non 200-300 status will reject with an Error object. The error has a response which is the response object from request.

mailchimp
  .get('/list/my-list-id')
  .catch((error) => {
    console.log(error); // Mailchimp Error: 401
    console.log(error.response);
  });

Contributing

After cloning this repository:

npm i

# run the tests
npm t

About

A lightweight wrapper for Mailchimp's v2 and v3 apis


Languages

Language:JavaScript 100.0%