# mailchimp-api-js

> A super simple Mailchimp V3 wrapper in JS.

Latest version **0.2.1** (published 2018-03-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install mailchimp-api-js
pnpm add mailchimp-api-js
yarn add mailchimp-api-js
bun add mailchimp-api-js
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.1 |
| Published | 2018-03-17 |
| First published | 2017-01-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 30 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 22 |
| Author | Calvin Chan @calvintychan |
| Maintainers | calvintychan |
| Keywords | mailchimp, api |

## Links

- npm: https://www.npmjs.com/package/mailchimp-api-js
- Repository: https://github.com/calvintychan/mailchimp-api
- Homepage: https://github.com/calvintychan/mailchimp-api#readme
- Issues: https://github.com/calvintychan/mailchimp-api/issues
- npm.io page: https://npm.io/package/mailchimp-api-js

## Dependencies (1)

- [superagent](https://npm.io/package/superagent.md) ^3.3.2

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 0.2.1 (latest) — 2018-03-17
- 0.2.0 — 2018-03-17
- 0.1.0 — 2017-01-21

## README

# mailchimp-api
A dead simple Mailchimp API v3 wrapper in JS.

### Usage
This can be installed via npm using:
`$ npm install mailchimp-api-js`

Then require the module in your code:
```js
const Mailchimp = require('mailchimp-api-js');

// or ES6 import
import Mailchimp from 'mailchimp-api-js';
```

Initialize by passing the Mailchimp API key and username:
```js
const mc = new Mailchimp('your-username', 'your-mailchimp-api-key');
```

### API Examples
Create a list
```js
const listId = 'f88e932bf4';
const body = {
  name: 'The Taj Mahal',
  contact: {
    company: 'Visionary Monkey',
    address: '580 Howard St.',
    city: 'San Francisco',
    zip: '94011',
    country: 'US',
  },
  permission_reminder: 'You are getting this email because you are awesome.',
  campaign_defaults: {
    from_name: 'Calvin Chan',
    from_email: 'calvin-secret@emai.com',
    subject: 'Newsletter',
    language: 'English',
  },
  email_type_option: false,
};

mc.lists.create(listId, body)
  .then((res) => {
    console.log(res);
  });
```

---
_Source: https://npm.io/package/mailchimp-api-js · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._