Wepublish Mailchimp

A TypeScript wrapper for the Mailchimp Marketing API.

Installation

npm install @codefabrik/wepublish-mailchimp

Usage

import { Mailchimp } from "@codefabrik/wepublish-mailchimp";

const mailchimp = new Mailchimp("your-api-key");

API

getInfoString(): Promise<string>

Returns a formatted string with all lists, merge fields, and interest groups.

getInfoJson(): Promise<MailchimpInfo>

Returns structured data about all lists, merge fields, and interest groups.

addContact(listId: string, data: ContactData): Promise<void>

Adds or updates a contact in a list.

await mailchimp.addContact("list-id", {
  email: "[email protected]",
  status: "subscribed", // or "pending"
  mergeFields: { FNAME: "John", LNAME: "Doe" },
  interests: { "interest-id": true }
});

getContacts(listId: string): Promise<ListMembersInfoSuccessResponse>

Retrieves all contacts from a list with automatic pagination.

Development

Build

yarn build

Publish

yarn npm publish