cli-anything-mailchimp

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

cli-anything-mailchimp

Identity

工具标识

An agent-native CLI for the Mailchimp Marketing API v3.0, built on the CLI-Anything framework.

一款基于CLI-Anything框架构建的、原生适配Agent的Mailchimp Marketing API v3.0 CLI工具。

What This CLI Does

该CLI的功能

Manage audiences (lists) — create, update, delete lists; add/update/archive members; manage merge fields, segments, tags, and webhooks.
Run campaigns — create, schedule, send, pause, replicate, and analyse email campaigns.
Read reports — open rates, click rates, bounce stats, unsubscribes, email activity, geographic data.
Control automations — create and manage automated email workflows.
Manage e-commerce — stores, orders, customers, products, carts, and promo codes.
Use templates, file manager, landing pages, SMS campaigns, surveys, and all other Marketing API resources.

管理受众（列表）——创建、更新、删除列表；添加、更新、归档成员；管理合并字段、细分群体、标签和Webhook。
运行营销活动——创建、排期、发送、暂停、复制和分析电子邮件营销活动。
查看报告——打开率、点击率、退信统计、退订记录、邮件活动数据、地域数据。
控制自动化流程——创建和管理自动化电子邮件工作流。
管理电商业务——店铺、订单、客户、商品、购物车和优惠码。
使用模板、文件管理器、着陆页、SMS营销活动、调查问卷及所有其他Marketing API资源。

Prerequisites

前置条件

Python 3.10+
```
MAILCHIMP_API_KEY
```
environment variable set to your API key (including datacenter suffix, e.g.
```
abc123-us8
```
)

Python 3.10+
设置
```
MAILCHIMP_API_KEY
```
环境变量为你的API密钥（需包含数据中心后缀，例如
```
abc123-us8
```
）

Installation

安装步骤

bash

undefined

bash

undefined

From the CLI-Anything repo (once merged):

从CLI-Anything仓库安装（合并后）:

pip install git+https://github.com/HKUDS/CLI-Anything.git#subdirectory=mailchimp/agent-harness

During development:

开发环境安装:

cd mailchimp/agent-harness && pip install -e .

undefined

cd mailchimp/agent-harness && pip install -e .

undefined

Command Reference

命令参考

Root

根命令

Command	Description
`cli-anything-mailchimp ping`	Health check — confirms API connectivity
`cli-anything-mailchimp root list`	Get account info
`cli-anything-mailchimp --json <cmd>`	Output any command as JSON
`cli-anything-mailchimp`	Launch interactive REPL

命令	描述
`cli-anything-mailchimp ping`	健康检查——确认API连通性
`cli-anything-mailchimp root list`	获取账户信息
`cli-anything-mailchimp --json <cmd>`	以JSON格式输出任意命令结果
`cli-anything-mailchimp`	启动交互式REPL模式

Lists (Audiences)

列表（受众）

Command	Description
`lists list`	List all audiences
`lists get <LIST_ID>`	Get audience info
`lists create --data '<json>'`	Create audience
`lists update <LIST_ID> --data '<json>'`	Update audience
`lists delete <LIST_ID>`	Delete audience
`lists list-lists-id-members <LIST_ID>`	List members
`lists get-lists-id-members-id <LIST_ID> <SUBSCRIBER_HASH>`	Get member by MD5 hash
`lists create-lists-id-members <LIST_ID> --data '<json>'`	Add member
`lists list-lists-id-merge-fields <LIST_ID>`	List merge fields
`lists create-lists-id-merge-fields <LIST_ID> --data '<json>'`	Add merge field
`lists list-lists-id-segments <LIST_ID>`	List segments
`lists list-list-member-tags <LIST_ID> <SUBSCRIBER_HASH>`	List member tags
`lists create-list-member-tags <LIST_ID> <SUBSCRIBER_HASH> --data '<json>'`	Add/remove member tags
`lists list-lists-id-webhooks <LIST_ID>`	List webhooks
`lists create-lists-id-webhooks <LIST_ID> --data '<json>'`	Add webhook

命令	描述
`lists list`	列出所有受众
`lists get <LIST_ID>`	获取受众信息
`lists create --data '<json>'`	创建受众
`lists update <LIST_ID> --data '<json>'`	更新受众信息
`lists delete <LIST_ID>`	删除受众
`lists list-lists-id-members <LIST_ID>`	列出受众成员
`lists get-lists-id-members-id <LIST_ID> <SUBSCRIBER_HASH>`	通过MD5哈希值获取成员信息
`lists create-lists-id-members <LIST_ID> --data '<json>'`	添加受众成员
`lists list-lists-id-merge-fields <LIST_ID>`	列出合并字段
`lists create-lists-id-merge-fields <LIST_ID> --data '<json>'`	添加合并字段
`lists list-lists-id-segments <LIST_ID>`	列出细分群体
`lists list-list-member-tags <LIST_ID> <SUBSCRIBER_HASH>`	列出成员标签
`lists create-list-member-tags <LIST_ID> <SUBSCRIBER_HASH> --data '<json>'`	添加/移除成员标签
`lists list-lists-id-webhooks <LIST_ID>`	列出Webhook
`lists create-lists-id-webhooks <LIST_ID> --data '<json>'`	添加Webhook

Campaigns

营销活动

Command	Description
`campaigns list`	List campaigns
`campaigns get <CAMPAIGN_ID>`	Get campaign info
`campaigns create --data '<json>'`	Create campaign
`campaigns update <CAMPAIGN_ID> --data '<json>'`	Update campaign settings
`campaigns delete <CAMPAIGN_ID>`	Delete campaign
`campaigns send <CAMPAIGN_ID>`	Send campaign immediately
`campaigns schedule <CAMPAIGN_ID> --data '<json>'`	Schedule campaign
`campaigns cancel-send <CAMPAIGN_ID>`	Cancel scheduled send
`campaigns pause <CAMPAIGN_ID>`	Pause RSS campaign
`campaigns resume <CAMPAIGN_ID>`	Resume RSS campaign
`campaigns replicate <CAMPAIGN_ID>`	Duplicate campaign
`campaigns list-content <CAMPAIGN_ID>`	Get campaign content
`campaigns list-send-checklist <CAMPAIGN_ID>`	Pre-send checklist

命令	描述
`campaigns list`	列出所有营销活动
`campaigns get <CAMPAIGN_ID>`	获取营销活动信息
`campaigns create --data '<json>'`	创建营销活动
`campaigns update <CAMPAIGN_ID> --data '<json>'`	更新营销活动设置
`campaigns delete <CAMPAIGN_ID>`	删除营销活动
`campaigns send <CAMPAIGN_ID>`	立即发送营销活动
`campaigns schedule <CAMPAIGN_ID> --data '<json>'`	排期营销活动
`campaigns cancel-send <CAMPAIGN_ID>`	取消已排期的发送
`campaigns pause <CAMPAIGN_ID>`	暂停RSS营销活动
`campaigns resume <CAMPAIGN_ID>`	恢复RSS营销活动
`campaigns replicate <CAMPAIGN_ID>`	复制营销活动
`campaigns list-content <CAMPAIGN_ID>`	获取营销活动内容
`campaigns list-send-checklist <CAMPAIGN_ID>`	发送前检查清单

Reports

报告

Command	Description
`reports list`	List all campaign reports
`reports get <CAMPAIGN_ID>`	Get campaign summary report
`reports list-email-activity <CAMPAIGN_ID>`	Per-subscriber open/click activity
`reports list-click-details <CAMPAIGN_ID>`	Link click breakdown
`reports list-open-details <CAMPAIGN_ID>`	Per-subscriber opens
`reports list-unsubscribed <CAMPAIGN_ID>`	Unsubscribers
`reports list-locations <CAMPAIGN_ID>`	Geographic breakdown
`reports list-domain-performance <CAMPAIGN_ID>`	Per-domain stats

命令	描述
`reports list`	列出所有营销活动报告
`reports get <CAMPAIGN_ID>`	获取营销活动汇总报告
`reports list-email-activity <CAMPAIGN_ID>`	单个订阅者的打开/点击活动数据
`reports list-click-details <CAMPAIGN_ID>`	链接点击明细
`reports list-open-details <CAMPAIGN_ID>`	单个订阅者的打开记录
`reports list-unsubscribed <CAMPAIGN_ID>`	退订用户列表
`reports list-locations <CAMPAIGN_ID>`	地域分布明细
`reports list-domain-performance <CAMPAIGN_ID>`	各域名统计数据

Automations

自动化流程

Command	Description
`automations list`	List automations
`automations get <WORKFLOW_ID>`	Get automation info
`automations create --data '<json>'`	Create automation
`automations pause <WORKFLOW_ID>`	Pause automation
`automations start <WORKFLOW_ID>`	Start automation
`automations archive <WORKFLOW_ID>`	Archive automation
`automations list-emails <WORKFLOW_ID>`	List automation emails

命令	描述
`automations list`	列出所有自动化流程
`automations get <WORKFLOW_ID>`	获取自动化流程信息
`automations create --data '<json>'`	创建自动化流程
`automations pause <WORKFLOW_ID>`	暂停自动化流程
`automations start <WORKFLOW_ID>`	启动自动化流程
`automations archive <WORKFLOW_ID>`	归档自动化流程
`automations list-emails <WORKFLOW_ID>`	列出自动化流程中的邮件

E-commerce

电商业务

Command	Description
`ecommerce list-ecommerce-stores`	List stores
`ecommerce get <STORE_ID>`	Get store info
`ecommerce create --data '<json>'`	Add store
`ecommerce list-ecommerce-stores-id-orders <STORE_ID>`	List orders
`ecommerce list-ecommerce-stores-id-products <STORE_ID>`	List products
`ecommerce list-ecommerce-stores-id-customers <STORE_ID>`	List customers
`ecommerce list-ecommerce-stores-id-carts <STORE_ID>`	List carts
`ecommerce list-ecommerce-stores-id-promocodes <PROMO_RULE_ID> <STORE_ID>`	List promo codes

命令	描述
`ecommerce list-ecommerce-stores`	列出所有店铺
`ecommerce get <STORE_ID>`	获取店铺信息
`ecommerce create --data '<json>'`	添加店铺
`ecommerce list-ecommerce-stores-id-orders <STORE_ID>`	列出订单
`ecommerce list-ecommerce-stores-id-products <STORE_ID>`	列出商品
`ecommerce list-ecommerce-stores-id-customers <STORE_ID>`	列出客户
`ecommerce list-ecommerce-stores-id-carts <STORE_ID>`	列出购物车
`ecommerce list-ecommerce-stores-id-promocodes <PROMO_RULE_ID> <STORE_ID>`	列出优惠码

Other Resources

其他资源

Group	Description
`templates`	Email templates (list, get, create, update, delete)
`template-folders`	Template folders
`campaign-folders`	Campaign folders
`file-manager`	Files and folders in the file manager
`landing-pages`	Landing pages (list, create, publish, unpublish)
`sms-campaigns`	SMS campaigns (10 operations)
`surveys`	Surveys (list, get, publish)
`reporting`	Facebook ad and landing page reporting
`search-campaigns`	Search campaigns by query
`search-members`	Search members across all audiences
`batches`	Batch API operations
`batch-webhooks`	Batch operation webhooks
`verified-domains`	Email domain verification
`authorized-apps`	OAuth connected apps
`connected-sites`	Connected site integrations
`conversations`	Inbox conversations
`activity-feed`	Account activity feed
`account-exports`	Account data exports

分组	描述
`templates`	电子邮件模板（列出、获取、创建、更新、删除）
`template-folders`	模板文件夹
`campaign-folders`	营销活动文件夹
`file-manager`	文件管理器中的文件和文件夹
`landing-pages`	着陆页（列出、创建、发布、下架）
`sms-campaigns`	SMS营销活动（10项操作）
`surveys`	调查问卷（列出、获取、发布）
`reporting`	Facebook广告和着陆页报告
`search-campaigns`	通过查询语句搜索营销活动
`search-members`	跨所有受众搜索成员
`batches`	批量API操作
`batch-webhooks`	批量操作Webhook
`verified-domains`	电子邮件域名验证
`authorized-apps`	OAuth授权应用
`connected-sites`	关联站点集成
`conversations`	收件箱对话
`activity-feed`	账户活动动态
`account-exports`	账户数据导出

JSON Output

JSON输出

All commands support

--json

at the root level:

bash

undefined

所有命令均支持在根级别使用

--json

参数：

bash

undefined

List all audiences as JSON

以JSON格式列出所有受众

cli-anything-mailchimp --json lists list

Get a campaign report as JSON

以JSON格式获取营销活动报告

cli-anything-mailchimp --json reports get abc123def

Pipe to jq — use the native Mailchimp field name for the resource

管道输出至jq——使用Mailchimp原生资源字段名

cli-anything-mailchimp --json lists list | jq '.lists[].name' cli-anything-mailchimp --json campaigns list | jq '.campaigns[].id'


**Envelope shapes** (native Mailchimp API response — use the resource-specific key):

```json
// List endpoints — key matches the resource name (lists, campaigns, members, etc.)
{"lists": [...], "total_items": 42, "_links": [...]}
{"campaigns": [...], "total_items": 10, "_links": [...]}

// Single resource GET / POST / PATCH
{"id": "abc123", "name": "My List", ...}

// DELETE
{"ok": true, "message": "Deleted."}

// Error
{"ok": false, "message": "Resource Not Found: ...", "data": {...}}

cli-anything-mailchimp --json lists list | jq '.lists[].name' cli-anything-mailchimp --json campaigns list | jq '.campaigns[].id'


**返回结构**（Mailchimp API原生响应——使用资源特定的键）：

```json
// 列表类端点——键名与资源名称匹配（lists, campaigns, members等）
{"lists": [...], "total_items": 42, "_links": [...]}
{"campaigns": [...], "total_items": 10, "_links": [...]}

// 单个资源的GET / POST / PATCH请求
{"id": "abc123", "name": "My List", ...}

// DELETE请求
{"ok": true, "message": "Deleted."}

// 错误响应
{"ok": false, "message": "Resource Not Found: ...", "data": {...}}

Common Agent Patterns

常见Agent使用模式

bash

undefined

bash

undefined

Get account health

获取账户健康状态

cli-anything-mailchimp --json ping | jq '.health_status'

List all audience IDs and names

列出所有受众ID和名称

cli-anything-mailchimp --json lists list | jq '.lists[] | {id, name}'

Find all subscribed members in an audience

查找受众中所有已订阅成员

cli-anything-mailchimp --json lists list-lists-id-members <list_id> --status subscribed | jq '.members[].email_address'

Create a campaign and get its send checklist

创建营销活动并获取发送检查清单

cli-anything-mailchimp --json campaigns create --data '{"type":"regular","settings":{"subject_line":"Hello","from_name":"Me","reply_to":"me@example.com"}}' | jq '.id' cli-anything-mailchimp --json campaigns list-send-checklist <campaign_id> | jq '.items[] | select(.result == false)'

Get unsubscribes for a sent campaign

获取已发送营销活动的退订用户

cli-anything-mailchimp --json reports list-unsubscribed <campaign_id> | jq '.unsubscribes[].email_address'

Add a member to an audience (subscriber hash = MD5 of lowercased email)

添加成员到受众（订阅者哈希值为邮箱小写后的MD5值）

cli-anything-mailchimp --json lists create-members <list_id> --data '{"email_address":"user@example.com","status":"subscribed"}'

Search for a member across all audiences

跨所有受众搜索成员

cli-anything-mailchimp --json search-members list --query "user@example.com" | jq '.exact_matches.members[]'

undefined

cli-anything-mailchimp --json search-members list --query "user@example.com" | jq '.exact_matches.members[]'

undefined

Interactive REPL

交互式REPL

Run

cli-anything-mailchimp

with no arguments to enter the REPL:

◆  cli-anything · Mailchimp
   v0.1.0
   Type help for commands, quit to exit

◆ mailchimp ❯ ping
  ✓ {"health_status": "Everything's Chimpy!"}

◆ mailchimp ❯ --json lists list
{"lists": [...], "total_items": 3, "_links": [...]}

◆ mailchimp ❯ quit

不带参数运行

cli-anything-mailchimp

即可进入REPL模式：

◆  cli-anything · Mailchimp
   v0.1.0
   Type help for commands, quit to exit

◆ mailchimp ❯ ping
  ✓ {"health_status": "Everything's Chimpy!"}

◆ mailchimp ❯ --json lists list
{"lists": [...], "total_items": 3, "_links": [...]}

◆ mailchimp ❯ quit

Notes

注意事项

Subscriber hash: Mailchimp identifies members by the MD5 hash of their lowercased email. Compute with

python -c "import hashlib; email='email@example.com'; print(hashlib.md5(email.strip().lower().encode()).hexdigest())"

Body payloads: All POST/PATCH/PUT commands accept
```
--data '<json>'
```
. See Mailchimp API docs for the schema of each endpoint.
Datacenter: Your API key ends in
```
-us8
```
,
```
-eu2
```
, etc. The CLI extracts this automatically — include it in
```
MAILCHIMP_API_KEY
```
.
Rate limits: The Marketing API rate-limits at 10 concurrent connections and a rolling per-account limit. For bulk operations, use the
```
batches
```
group.

订阅者哈希值：Mailchimp通过邮箱小写后的MD5哈希值识别成员，可通过以下命令计算：

python -c "import hashlib; email='email@example.com'; print(hashlib.md5(email.strip().lower().encode()).hexdigest())"

。

请求体：所有POST/PATCH/PUT命令均接受
```
--data '<json>'
```
参数，每个端点的JSON格式可参考Mailchimp API文档。
数据中心：你的API密钥后缀为
```
-us8
```
、
```
-eu2
```
等，CLI会自动提取该信息，请确保
```
MAILCHIMP_API_KEY
```
包含此后缀。
速率限制：Marketing API限制10个并发连接，且有账户级滚动速率限制。如需批量操作，请使用
```
batches
```
分组命令。