Install
openclaw skills install @byungkyu/mailchimpMailchimp Marketing API integration with managed OAuth. Access audiences, campaigns, templates, automations, reports, and manage subscribers. Use this skill when users want to manage email marketing, subscriber lists, or automate email campaigns. For other third party apps, use the api-gateway skill (https://clawhub.ai/byungkyu/api-gateway). Calls run through the maton CLI with OAuth login; default to read and list calls, and confirm every write or new connection with the user.
openclaw skills install @byungkyu/mailchimpAccess the Mailchimp Marketing API with managed OAuth authentication. Manage audiences, campaigns, templates, automations, reports, and subscribers for email marketing.
All access runs through the Maton gateway and the maton CLI.
maton login --oauth # authenticate once (OAuth, recommended)
maton connection create mailchimp # connect the account (needs user approval)
maton api '/mailchimp/3.0/lists' # first call
npm install -g @maton/cli
brew install maton-ai/cli/maton
maton login --oauth
Opens the OAuth login page in the browser and waits for authorization. Once complete, it creates a profile in config.toml (eg. $HOME/.config/maton/config.toml) and stores the access and refresh tokens in the operating system's credential store (Keychain on macOS, Credential Manager on Windows, Secret Service on Linux), auto-renewed on expiry. The CLI reads them when it needs them; nothing else should.
maton login --interactive
Requires manually copying an API key from Settings, which is error prone. Once complete, it also creates a profile in config.toml and stores the key in the same credential store. It is preferred over export MATON_API_KEY=..., which exposes a long-lived credential to every child process. When MATON_API_KEY is set, it overrides the active profile. If the CLI cannot be installed at all, see Appendix: Environments Without the CLI for the raw HTTP form and the rules for handling the key.
maton whoami --json
{
"authenticated": true,
"profile_name": "alice@example.com",
"auth_type": "oauth"
}
authenticated is false, stop and login again via maton login --oauth.auth_type is api_key, it is recommended to login via maton login --oauth and avoid keeping a long-lived credential.maton connection list mailchimp --status ACTIVE
{
"connections": [
{
"connection_id": "{connection_id}",
"status": "ACTIVE",
"creation_time": "2025-12-08T07:20:53.488460Z",
"last_updated_time": "2026-01-31T20:03:32.593153Z",
"url": "https://connect.maton.ai/?session_token=5e9...",
"app": "mailchimp",
"method": "OAUTH2",
"metadata": {}
}
]
}
Refer to maton connection list --help for possible flags and values.
Requires explicit user approval. Confirm that the user intends to authorize Mailchimp access before running this. Never create a connection on your own initiative.
maton connection create mailchimp
Refer to maton connection create --help for possible flags and values.
maton connection get {connection_id}
{
"connection": {
"connection_id": "{connection_id}",
"status": "PENDING",
"creation_time": "2025-12-08T07:20:53.488460Z",
"last_updated_time": "2026-01-31T20:03:32.593153Z",
"url": "https://connect.maton.ai/?session_token=5e9...",
"app": "mailchimp",
"metadata": {}
}
}
Open the returned URL in a browser to complete authorizing Mailchimp. If Mailchimp offers scope selection, choose only the scopes the current task needs.
maton connection delete {connection_id} --yes
If there are multiple Mailchimp connections, specify which one to use so requests go to the intended account:
maton api '/mailchimp/3.0/lists' --connection {connection_id}
Mailchimp has no typed maton mailchimp commands yet, so every call goes through maton api.
maton api '/mailchimp/3.0/lists'
Paths are /mailchimp/{native-api-path}. The gateway forwards everything after the app segment to {dc}.api.mailchimp.com and injects the credential for the connection. Query strings, custom headers (except Host and Authorization), and all HTTP methods pass through. Send a JSON body with --input -:
maton api -X POST '/mailchimp/{native-api-path}' -H 'Content-Type: application/json' --input - <<'JSON'
{"key": "value"}
JSON
Refer to maton api --help for possible flags and values.
Maton proxies requests to your Mailchimp data center and automatically injects your OAuth token.
maton login --oauth, the token is held by the operating system's credential store and the CLI renews it on its own. Do not print it, write it to a file, pass it on a command line, or run maton token to look at one — only to hand it to a program that needs it.config.toml, or any other credential file — not for this skill, not for another application, and not to "check" that auth works (use maton whoami). Let the CLI use its own stored credential; the agent never needs the value. The same applies to unrelated secrets on the machine: .env files, SSH keys, cloud CLI credentials, and browser profiles are out of scope for an API gateway and must not be read or transmitted.api.maton.ai. Prefer endpoints that work with the gateway-injected connection credential.maton connection delete {connection_id}).maton connection create mailchimp. Never create connections on the agent's own initiative.--connection when the user has multiple connections for this app, and -p/--profile when they have multiple Maton accounts. Do not let an ambiguous default decide where a write lands.Within the Mailchimp app, "audience" is the common term, but the API uses "lists" for endpoints.
maton api '/mailchimp/3.0/lists'
Query parameters:
count - Number of records to return (default 10, max 1000)offset - Number of records to skip (for pagination)fields - Comma-separated list of fields to includeexclude_fields - Comma-separated list of fields to excludeExample:
maton api '/mailchimp/3.0/lists?count=10'
Response:
{
"lists": [
{
"id": "abc123def4",
"name": "Newsletter Subscribers",
"contact": {
"company": "Acme Corp",
"address1": "123 Main St"
},
"stats": {
"member_count": 5000,
"unsubscribe_count": 100,
"open_rate": 0.25
}
}
],
"total_items": 1
}
maton api '/mailchimp/3.0/lists/{list_id}'
Example:
maton api '/mailchimp/3.0/lists/abc123def4'
maton api -X POST '/mailchimp/3.0/lists' -H 'Content-Type: application/json' --input - <<'JSON'
{
"name": "Newsletter",
"contact": {
"company": "Acme Corp",
"address1": "123 Main St",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "US"
},
"permission_reminder": "You signed up for our newsletter",
"campaign_defaults": {
"from_name": "Acme Corp",
"from_email": "newsletter@acme.com",
"subject": "",
"language": "en"
},
"email_type_option": true
}
JSON
maton api -X PATCH '/mailchimp/3.0/lists/{list_id}'
maton api -X DELETE '/mailchimp/3.0/lists/{list_id}'
Members are contacts within an audience. The API uses MD5 hash of the lowercase email address as the subscriber identifier.
maton api '/mailchimp/3.0/lists/{list_id}/members'
Query parameters:
status - Filter by subscription status (subscribed, unsubscribed, cleaned, pending, transactional)count - Number of records to returnoffset - Number of records to skipExample:
maton api '/mailchimp/3.0/lists/abc123def4/members?status=subscribed&count=50'
Response:
{
"members": [
{
"id": "f4b7c8d9e0",
"email_address": "john@example.com",
"status": "subscribed",
"merge_fields": {
"FNAME": "John",
"LNAME": "Doe"
},
"tags": [
{"id": 1, "name": "VIP"}
]
}
],
"total_items": 500
}
maton api '/mailchimp/3.0/lists/{list_id}/members/{subscriber_hash}'
The subscriber_hash is the MD5 hash of the lowercase email address.
Example:
maton api '/mailchimp/3.0/lists/abc123def4/members/b4c9a0d1e2f3g4h5'
maton api -X POST '/mailchimp/3.0/lists/{list_id}/members' -H 'Content-Type: application/json' --input - <<'JSON'
{
"email_address": "newuser@example.com",
"status": "subscribed",
"merge_fields": {
"FNAME": "Jane",
"LNAME": "Smith"
},
"tags": ["Newsletter", "Premium"]
}
JSON
Example:
maton api -X POST '/mailchimp/3.0/lists/abc123def4/members' -H 'Content-Type: application/json' --input - <<'JSON'
{
"email_address": "newuser@example.com",
"status": "subscribed",
"merge_fields": {
"FNAME": "Jane",
"LNAME": "Smith"
}
}
JSON
maton api -X PATCH '/mailchimp/3.0/lists/{list_id}/members/{subscriber_hash}'
Example:
maton api -X PATCH '/mailchimp/3.0/lists/abc123def4/members/b4c9a0d1e2f3g4h5' -H 'Content-Type: application/json' --input - <<'JSON'
{
"merge_fields": {
"FNAME": "Jane",
"LNAME": "Doe"
}
}
JSON
maton api -X PUT '/mailchimp/3.0/lists/{list_id}/members/{subscriber_hash}' -H 'Content-Type: application/json' --input - <<'JSON'
{
"email_address": "user@example.com",
"status_if_new": "subscribed",
"merge_fields": {
"FNAME": "Jane",
"LNAME": "Smith"
}
}
JSON
Creates a new member or updates an existing one based on the email hash. Use status_if_new to set the status when creating a new member.
Archives a member (can be re-added later):
maton api -X DELETE '/mailchimp/3.0/lists/{list_id}/members/{subscriber_hash}'
Returns 204 No Content on success.
To permanently delete (GDPR compliant):
maton api -X POST '/mailchimp/3.0/lists/{list_id}/members/{subscriber_hash}/actions/delete-permanent'
maton api '/mailchimp/3.0/lists/{list_id}/members/{subscriber_hash}/tags'
maton api -X POST '/mailchimp/3.0/lists/{list_id}/members/{subscriber_hash}/tags' -H 'Content-Type: application/json' --input - <<'JSON'
{
"tags": [
{"name": "VIP", "status": "active"},
{"name": "Old Tag", "status": "inactive"}
]
}
JSON
Returns 204 No Content on success.
maton api '/mailchimp/3.0/lists/{list_id}/segments'
Example:
maton api '/mailchimp/3.0/lists/abc123def4/segments'
maton api -X POST '/mailchimp/3.0/lists/{list_id}/segments' -H 'Content-Type: application/json' --input - <<'JSON'
{
"name": "Active Subscribers",
"options": {
"match": "all",
"conditions": [
{
"condition_type": "EmailActivity",
"field": "opened",
"op": "date_within",
"value": "30"
}
]
}
}
JSON
maton api -X PATCH '/mailchimp/3.0/lists/{list_id}/segments/{segment_id}'
maton api '/mailchimp/3.0/lists/{list_id}/segments/{segment_id}/members'
maton api -X DELETE '/mailchimp/3.0/lists/{list_id}/segments/{segment_id}'
Returns 204 No Content on success.
maton api '/mailchimp/3.0/campaigns'
Query parameters:
type - Campaign type (regular, plaintext, absplit, rss, variate)status - Campaign status (save, paused, schedule, sending, sent)list_id - Filter by list IDcount - Number of records to returnoffset - Number of records to skipExample:
maton api '/mailchimp/3.0/campaigns?status=sent&count=20'
Response:
{
"campaigns": [
{
"id": "campaign123",
"type": "regular",
"status": "sent",
"settings": {
"subject_line": "Monthly Newsletter",
"from_name": "Acme Corp"
},
"send_time": "2025-02-01T10:00:00Z",
"report_summary": {
"opens": 1500,
"clicks": 300,
"open_rate": 0.30,
"click_rate": 0.06
}
}
],
"total_items": 50
}
maton api '/mailchimp/3.0/campaigns/{campaign_id}'
maton api -X POST '/mailchimp/3.0/campaigns' -H 'Content-Type: application/json' --input - <<'JSON'
{
"type": "regular",
"recipients": {
"list_id": "abc123def4"
},
"settings": {
"subject_line": "Your Monthly Update",
"from_name": "Acme Corp",
"reply_to": "hello@acme.com"
}
}
JSON
Example:
maton api -X POST '/mailchimp/3.0/campaigns' -H 'Content-Type: application/json' --input - <<'JSON'
{
"type": "regular",
"recipients": {
"list_id": "abc123def4"
},
"settings": {
"subject_line": "February Newsletter",
"from_name": "Acme Corp",
"reply_to": "newsletter@acme.com"
}
}
JSON
maton api -X PATCH '/mailchimp/3.0/campaigns/{campaign_id}'
maton api -X DELETE '/mailchimp/3.0/campaigns/{campaign_id}'
Returns 204 No Content on success.
maton api '/mailchimp/3.0/campaigns/{campaign_id}/content'
maton api -X PUT '/mailchimp/3.0/campaigns/{campaign_id}/content' -H 'Content-Type: application/json' --input - <<'JSON'
{
"html": "<html><body><h1>Hello!</h1><p>Newsletter content here.</p></body></html>",
"plain_text": "Hello! Newsletter content here."
}
JSON
Or use a template:
maton api -X PUT '/mailchimp/3.0/campaigns/{campaign_id}/content' -H 'Content-Type: application/json' --input - <<'JSON'
{
"template": {
"id": 12345,
"sections": {
"body": "<p>Custom content for the template section</p>"
}
}
}
JSON
Check if a campaign is ready to send:
maton api '/mailchimp/3.0/campaigns/{campaign_id}/send-checklist'
maton api -X POST '/mailchimp/3.0/campaigns/{campaign_id}/actions/send'
maton api -X POST '/mailchimp/3.0/campaigns/{campaign_id}/actions/schedule' -H 'Content-Type: application/json' --input - <<'JSON'
{
"schedule_time": "2025-03-01T10:00:00+00:00"
}
JSON
maton api -X POST '/mailchimp/3.0/campaigns/{campaign_id}/actions/cancel-send'
maton api '/mailchimp/3.0/templates'
Query parameters:
type - Template type (user, base, gallery)count - Number of records to returnoffset - Number of records to skipExample:
maton api '/mailchimp/3.0/templates?type=user'
maton api '/mailchimp/3.0/templates/{template_id}'
maton api '/mailchimp/3.0/templates/{template_id}/default-content'
maton api -X POST '/mailchimp/3.0/templates' -H 'Content-Type: application/json' --input - <<'JSON'
{
"name": "Newsletter Template",
"html": "<html><body mc:edit=\"body\"><h1>Title</h1><p>Content here</p></body></html>"
}
JSON
maton api -X PATCH '/mailchimp/3.0/templates/{template_id}'
maton api -X DELETE '/mailchimp/3.0/templates/{template_id}'
Returns 204 No Content on success.
Mailchimp's classic automations let you build email series triggered by dates, activities, or events.
maton api '/mailchimp/3.0/automations'
Example:
maton api '/mailchimp/3.0/automations'
maton api '/mailchimp/3.0/automations/{workflow_id}'
maton api -X POST '/mailchimp/3.0/automations/{workflow_id}/actions/start-all-emails'
maton api -X POST '/mailchimp/3.0/automations/{workflow_id}/actions/pause-all-emails'
maton api '/mailchimp/3.0/automations/{workflow_id}/emails'
Manually add a subscriber to an automation workflow:
maton api -X POST '/mailchimp/3.0/automations/{workflow_id}/emails/{workflow_email_id}/queue' -H 'Content-Type: application/json' --input - <<'JSON'
{
"email_address": "subscriber@example.com"
}
JSON
maton api '/mailchimp/3.0/reports'
Query parameters:
count - Number of records to returnoffset - Number of records to skiptype - Campaign typeExample:
maton api '/mailchimp/3.0/reports?count=20'
Response:
{
"reports": [
{
"id": "campaign123",
"campaign_title": "Monthly Newsletter",
"emails_sent": 5000,
"opens": {
"opens_total": 1500,
"unique_opens": 1200,
"open_rate": 0.24
},
"clicks": {
"clicks_total": 450,
"unique_clicks": 300,
"click_rate": 0.06
},
"unsubscribed": 10,
"bounce_rate": 0.02
}
]
}
maton api '/mailchimp/3.0/reports/{campaign_id}'
maton api '/mailchimp/3.0/reports/{campaign_id}/open-details'
maton api '/mailchimp/3.0/reports/{campaign_id}/click-details'
maton api '/mailchimp/3.0/lists/{list_id}/activity'
Returns recent daily aggregated activity stats (unsubscribes, signups, opens, clicks) for up to 180 days.
Process multiple operations in a single call.
maton api -X POST '/mailchimp/3.0/batches' -H 'Content-Type: application/json' --input - <<'JSON'
{
"operations": [
{
"method": "POST",
"path": "/lists/abc123def4/members",
"body": "{\"email_address\":\"user1@example.com\",\"status\":\"subscribed\"}"
},
{
"method": "POST",
"path": "/lists/abc123def4/members",
"body": "{\"email_address\":\"user2@example.com\",\"status\":\"subscribed\"}"
}
]
}
JSON
maton api '/mailchimp/3.0/batches/{batch_id}'
maton api '/mailchimp/3.0/batches'
maton api -X DELETE '/mailchimp/3.0/batches/{batch_id}'
Returns 204 No Content on success.
Mailchimp uses offset-based pagination:
maton api '/mailchimp/3.0/lists?count=50&offset=100'
Response includes total_items for calculating total pages:
{
"lists": [...],
"total_items": 250
}
| Status | Meaning |
|---|---|
| 200 | Success with response body |
| 204 | Success with no content (DELETE, some POST operations) |
| 400 | Bad request or missing Mailchimp connection |
| 401 | Invalid or missing Maton API key |
| 403 | Forbidden - insufficient permissions |
| 404 | Resource not found |
| 405 | Method not allowed |
| 429 | Rate limited |
| 4xx/5xx | Passthrough error from Mailchimp API |
Mailchimp error responses include detailed information:
{
"type": "https://mailchimp.com/developer/marketing/docs/errors/",
"title": "Invalid Resource",
"status": 400,
"detail": "The resource submitted could not be validated.",
"instance": "abc123-def456",
"errors": [
{
"field": "email_address",
"message": "This value should be a valid email."
}
]
}
Mailchimp has no typed accessor yet, so calls go through the api passthrough, which takes the app and the path after it. login() opens a browser once per machine and writes the session to the SDK's own store — maton login does not carry over, and the SDK never signs in implicitly.
Python
pip install maton-ai
from maton_ai import Maton, login
# login()
maton = Maton()
# maton = Maton(api_key="...")
result = maton.api.get("mailchimp", "/3.0/lists")
JavaScript
npm install @maton/sdk
import { Maton, login } from "@maton/sdk";
// await login()
const maton = new Maton();
// const maton = new Maton({ apiKey: "..." });
const result = await maton.api.get("mailchimp", "/3.0/lists");
| Status | Meaning |
|---|---|
| 400 | Missing Mailchimp connection |
| 401 | Invalid, missing, or expired Maton credential |
| 429 | Rate limited (10 requests/second per account) |
| 500 | Internal Server Error |
| 4xx/5xx | Passthrough error from the Mailchimp API |
Errors from Mailchimp are passed through with their original status codes and response bodies.
maton whoami --json
"authenticated": false — login again with maton login --oauth."auth_type": "api_key" — prefer maton login --oauth so no long-lived key sits on the machine.maton whoami is the check.Then confirm the app is connected:
maton connection list mailchimp --status ACTIVE
Paths passed to maton api must start with /mailchimp/:
maton api '/mailchimp/3.0/lists'maton api '/3.0/lists'A 500 may mean the Mailchimp authorization expired. With the user's approval, create a new connection (maton connection create mailchimp) and complete authorization; once it is ACTIVE, delete the stale connection so the gateway uses the new one.
maton api.--paginate walks every page and -q/--jq trims the response before it reaches you. On typed commands, --jq requires --json.maton api; Host and Authorization are set by the gateway.Everything above uses the CLI, which holds the credential itself and never exposes it to the caller. Use the raw HTTP form below only where the CLI cannot be installed — a locked-down container, a CI step, a sandbox with no package manager. If maton is available, maton api does the same job without handling a secret.
Calling https://api.maton.ai/ directly means holding a long-lived Maton API key in the process environment, where it is readable by every child process and easy to leak into logs, crash dumps, shell history, and pasted output. Handle it accordingly:
[ -n "$MATON_API_KEY" ] && echo "MATON_API_KEY is set" || echo "MATON_API_KEY is not set"
.env, or a script makes it permanent. Let the environment that starts the session supply it — a CI secret store, a container secret, a secrets manager.-H "Authorization: Bearer $MATON_API_KEY"), where it lands in ps output and shell history. Feed the header in on stdin instead, as below.api.maton.ai. It is not a credential for Mailchimp or any other third-party host.curl --config - reads the header from stdin, so the key is never a command-line argument and never reaches ps or shell history. Query values must be URL-encoded (is:unread becomes is%3Aunread).
curl --config - "https://api.maton.ai/mailchimp/3.0/lists" <<EOF
header = "Authorization: Bearer $MATON_API_KEY"
header = "User-Agent: maton-mailchimp-skill/1.1"
# Pin a specific connection when the account has more than one:
# header = "Maton-Connection: {connection_id}"
EOF
The same rules as the CLI apply to every request made this way: read-only calls first, and explicit user confirmation before any POST, PUT, PATCH, or DELETE.