{"id":17675132,"url":"https://github.com/ceoshikhar/chimplist","last_synced_at":"2025-10-09T12:42:45.168Z","repository":{"id":40762506,"uuid":"275563030","full_name":"ceoshikhar/chimplist","owner":"ceoshikhar","description":"Node.js Client for Mailchimp's API v3 to manage Lists/Audiences and their Members.","archived":false,"fork":false,"pushed_at":"2023-03-05T02:55:28.000Z","size":944,"stargazers_count":7,"open_issues_count":7,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-12T21:13:14.933Z","etag":null,"topics":["mailchimp","mailchimp-api","mailchimp-api-v3","mailchimp-api-wrapper","mailchimp-audiences","mailchimp-lists","nodejs"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ceoshikhar.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-06-28T10:41:43.000Z","updated_at":"2023-01-31T15:13:14.000Z","dependencies_parsed_at":"2024-10-24T08:35:09.929Z","dependency_job_id":"9f1a8029-0fb1-4dc6-ab19-af14585a0dd5","html_url":"https://github.com/ceoshikhar/chimplist","commit_stats":{"total_commits":36,"total_committers":3,"mean_commits":12.0,"dds":"0.33333333333333337","last_synced_commit":"301076423d81aaa212a6baf40c8123505dd7a290"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ceoshikhar%2Fchimplist","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ceoshikhar%2Fchimplist/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ceoshikhar%2Fchimplist/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ceoshikhar%2Fchimplist/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ceoshikhar","download_url":"https://codeload.github.com/ceoshikhar/chimplist/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253823462,"owners_count":21969848,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mailchimp","mailchimp-api","mailchimp-api-v3","mailchimp-api-wrapper","mailchimp-audiences","mailchimp-lists","nodejs"],"created_at":"2024-10-24T07:10:06.086Z","updated_at":"2025-10-09T12:42:40.137Z","avatar_url":"https://github.com/ceoshikhar.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# chimplist\n\n\u003cp align=\"center\"\u003e\n\u003cimg alt=\"npm\" src=\"https://img.shields.io/npm/dt/chimplist\"\u003e\n\u003cimg alt=\"Travis (.org)\" src=\"https://img.shields.io/travis/ceoshikhar/chimplist\"\u003e\n\u003cimg alt=\"npm\" src=\"https://img.shields.io/npm/v/chimplist\"\u003e\n\u003ca href='https://github.com/ceoshikhar/chimplist'\u003e\n\u003cimg alt=\"GitHub stars\" src=\"https://img.shields.io/github/stars/ceoshikhar/chimplist?style=social\"\u003e\n\u003c/a\u003e\n\u003c/p\u003e\n\nChimplist makes it very easy and simple to work with Mailchimp's API v3 to manage your Lists(also called Audiences) and their Members.\n\n## How to install?\n\n```bash\nnpm install chimplist\n```\n\n## How to use Chimplist?\n\n#### \\*ES6 Syntax\n\n```js\nconst Chimplist = require(\"chimplist\");\n\nconst API_KEY = \"your Mailchimp API KEY\";\n\nconst Chimp = new Chimplist(API_KEY);\n\n/* Using `getAllLists()` function to get information about all lists\n * All the available functions with Chimplist are mentioned down below.\n * This is how you would work with the new ES6 promise syntax with .then .catch */\nChimp.getAllLists()\n  .then((response) =\u003e {\n    // Work with the `response` from Mailchimp API\n    // `response` is a standard HTTP response(Headers, Body, etc).\n  })\n  .catch((error) =\u003e {\n    // Handle any errors while running `getAllLists()`\n  });\n\n// You can use async/await inside try/catch block as well\nconst functionName = async () =\u003e {\n  try {\n    const response = await Chimp.getAllLists();\n    // Work with the `response` from Mailchimp API\n  } catch (error) {\n    // Handle any errors while running `getAllLists()`\n  }\n};\n\n// Call the function to execute the try/catch block code\nfunctionName();\n```\n\n## Why Chimplist?\n\nA lot of people use Mailchimp for their `list` feature. Chimplist aims at the people who quickly just want to add a `sign up to newsletter` type of form to their website. This library aims to help them get started working with Mailchimp lists with ease and simplicity by making sure:\n\n- You don't have to worry about the Mailchimp's API end points.\n- You don't have to worry about handling authorizations.\n- You don't have to worry about knowing how to make HTTP requests.\n- You can use it on your back-end with just few lines of code.\n\nNote: At the moment, Chimplist do not support the capability to apply `request query parameters` to your API requests for keeping things simple. Maybe in the future that feature might be added, untill then you might like using something like [node-mailchimp](https://www.npmjs.com/package/mailchimp-api-v3).\n\n## Chimplist's Functions Guide\n\n**`list_id`** - The **list id**(also known as **Audience ID**) of the specific list you are targeting. Can be found in Audience -\u003e Settings -\u003e Audience name and campaign defaults. Data type is **`string`**.\n\n**`options`** - The data object which contains at least the **required** `request body parameters`. Reference links are provided down below along with those specific functions. Data type is **`object`**.\n\n**`subscriber_hash`** - According to Mailchimp API documentation: \"it is The MD5 hash of the lowercase version of the list member's email address\". But it's basically the `id` of the `member`. It looks like `5adgf4de580e68d565db69db203a5c88`. Data type is **`string`**.\n\n### LIST Functions\n\n- **createList(options)** - Create a new list\n\n  `options` -\u003e to learn more about what `options` should contain, refer to mailchimp api documentaion [here](https://mailchimp.com/developer/reference/lists/#post_/lists).\n\n* **getAllLists()** - Get information about all lists in the account.\n\n* **getList(list_id)** - Get information about a specific list.\n\n- **updateList(list_id, options)** - Update a specific list\n\n  `options` -\u003e To learn more about what `options` should contain, refer to Mailchimp API Documentaion [here](https://mailchimp.com/developer/reference/lists/#patch_/lists/-list_id-).\n\n* **deleteList(list_id)** - Delete a specific list\n\n### MEMBER Functions\n\n- **addMember(list_id, options)** - Add a new list member\n\n  `options` -\u003e to learn more about what `options` should contain, refer to mailchimp api documentaion [here](https://mailchimp.com/developer/reference/lists/list-members/#post_/lists/-list_id-/members).\n\n- **getAllMembers(list_id)** - Get information about members in a list\n\n- **getMember(list_id, subscriber_hash)** - Get information about a specific list memeber.\n\n- **updateMember(list_id, subscriber_hash, options)** - Update a specific list memeber.\n\n  `options` -\u003e to learn more about what `options` should contain, refer to mailchimp api documentaion [here](https://mailchimp.com/developer/reference/lists/list-members/#patch_/lists/-list_id-/members/-subscriber_hash-).\n\n- **archiveMember(list_id, subscriber_hash)** - Archive a list memeber.\n\n- **deleteMember(list_id, subscriber_hash)** - Permanently delete a list member.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fceoshikhar%2Fchimplist","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fceoshikhar%2Fchimplist","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fceoshikhar%2Fchimplist/lists"}