Modules@robinpath/mailchimp

@robinpath/mailchimp

0.1.1Public

Mailchimp module for RobinPath.

@robinpath/mailchimp

Mailchimp module for RobinPath.

Category Functions Auth License

Why use this module?

The mailchimp module lets you:

  • Get all audiences/lists in the account
  • Get details for a specific audience/list
  • Create a new audience/list with contact info and campaign defaults
  • Delete an audience/list
  • Get members of an audience/list with optional filtering

All functions are callable directly from RobinPath scripts with a simple, consistent API.

Installation

npm install @robinpath/mailchimp

Quick Start

1. Set up credentials

mailchimp.setCredentials "abc123-us21" "us21"

2. Get all audiences/lists in the account

mailchimp.getLists

Available Functions

FunctionDescription
mailchimp.setCredentialsStore Mailchimp API key and server prefix for authentication
mailchimp.getListsGet all audiences/lists in the account
mailchimp.getListGet details for a specific audience/list
mailchimp.createListCreate a new audience/list with contact info and campaign defaults
mailchimp.deleteListDelete an audience/list
mailchimp.getMembersGet members of an audience/list with optional filtering
mailchimp.getMemberGet a specific member by email address
mailchimp.addMemberAdd a new member to an audience/list
mailchimp.updateMemberUpdate an existing member's information
mailchimp.removeMemberArchive/remove a member from an audience/list
mailchimp.addTagAdd tags to a member in an audience/list
mailchimp.removeTagRemove tags from a member in an audience/list
mailchimp.getCampaignsList campaigns with optional filtering
mailchimp.getCampaignGet details for a specific campaign
mailchimp.createCampaignCreate a new campaign (regular, plaintext, or absplit)
mailchimp.updateCampaignUpdate campaign settings
mailchimp.deleteCampaignDelete a campaign
mailchimp.sendCampaignSend a campaign immediately
mailchimp.scheduleCampaignSchedule a campaign for future delivery
mailchimp.getCampaignContentGet the content of a campaign
mailchimp.setCampaignContentSet the content of a campaign with HTML or a template
mailchimp.getTemplatesList available email templates
mailchimp.getTemplateGet details for a specific template
mailchimp.searchMembersSearch for members across all lists or a specific list
mailchimp.getListActivityGet recent activity stats for an audience/list

Examples

Get all audiences/lists in the account

mailchimp.getLists

Get details for a specific audience/list

mailchimp.getList "abc123"

Create a new audience/list with contact info and campaign defaults

mailchimp.createList "My Newsletter" {"company": "Acme", "fromEmail": "news@acme.com", "fromName": "Acme News"}

Integration with RobinPath

import { RobinPath } from "@wiredwp/robinpath";
import Module from "@robinpath/mailchimp";

const rp = new RobinPath();
rp.registerModule(Module.name, Module.functions);
rp.registerModuleMeta(Module.name, Module.functionMetadata);

const result = await rp.executeScript(`
  mailchimp.setCredentials "abc123-us21" "us21"
  mailchimp.getLists
`);

Full API Reference

See MODULE.md for complete documentation including all parameters, return types, error handling, and advanced examples.

Related Modules

License

MIT

Versions (1)

VersionTagPublished
0.1.1latestyesterday
Install
$ robinpath install @robinpath/mailchimp
Version0.1.1
LicenseMIT
Unpacked Size8.4 KB
Versions1
Weekly Downloads0
Total Downloads0
Stars0
Last Publishyesterday
Createdyesterday

Category

marketing