The catalogue/Mailchimp

Mailchimp

app.mailchimp

Mailchimp email marketing — manage audiences, campaigns, subscribers, templates, and automations.

API keymarketingRead the source
Version2.0.0
Categorymarketing
AuthAPI key
Tools18
Transportstdio
LicenceMIT
02

Tools

18 tools the agent can call.

Every one is declared with typed parameters and returns structured results, so the host can render them instead of narrating them.

  • add-subscriberAdd a subscriber to a Mailchimp audience (POST /lists/{listId}/members). Returns the created subscriber. Params: listId (required), email_address (required), status? ("subscribed"|"unsubscribed"|"cleaned"|"pending"|"transactional", default "subscribed"), merge_fields? ({ FNAME?, LNAME?, ... }).
  • create-campaignCreate a campaign in Mailchimp (POST /campaigns). Returns the created campaign. Params: type (required, "regular"|"plaintext"|"absplit"|"rss"|"variate"), recipients? ({ list_id }), settings? ({ subject_line?, from_name?, reply_to?, ... }).
  • create-segmentCreate a segment in a Mailchimp audience (POST /lists/{listId}/segments). Returns the created segment. Params: listId (required), name (required), static_segment? (array of emails for static segment), conditions? ({ match: "any"|"all", conditions: [...] } for dynamic segment).
  • delete-subscriberPermanently delete a subscriber from a Mailchimp audience (DELETE /lists/{listId}/members/{subscriberHash}). Returns { deleted: true }. Params: listId (required), subscriberHash (required, MD5 hash of lowercase email).
  • get-audienceGet one audience (list) by id from Mailchimp (GET /lists/{listId}). Returns audience details including stats and member count. Params: listId (required, string).
  • get-campaignGet one campaign by id from Mailchimp (GET /campaigns/{campaignId}). Returns campaign details. Params: campaignId (required, string).
  • get-campaign-reportGet a campaign report from Mailchimp (GET /reports/{campaignId}). Returns performance data including opens, clicks, bounces, unsubscribes. Params: campaignId (required, string).
  • get-templateGet one template by id from Mailchimp (GET /templates/{templateId}). Returns template details. Params: templateId (required, number).
  • list-audiencesList audiences (lists) from Mailchimp (GET /lists). Returns { audiences, total_items, count }. Params: count? (1-1000, default 10).
  • list-automationsList automations from Mailchimp (GET /automations). Returns { automations, total_items, count }. Params: count? (1-1000, default 10).
  • list-campaignsList campaigns from Mailchimp (GET /campaigns). Returns { campaigns, total_items, count }. Params: count? (1-1000, default 10).
  • list-merge-fieldsList merge fields for a Mailchimp audience (GET /lists/{listId}/merge-fields). Returns { merge_fields, total_items, count }. Params: listId (required), count? (1-1000, default 10).
  • list-segmentsList segments for a Mailchimp audience (GET /lists/{listId}/segments). Returns { segments, total_items, count }. Params: listId (required), count? (1-1000, default 10).
  • list-subscribersList subscribers (members) of an audience from Mailchimp (GET /lists/{listId}/members). Returns { subscribers, total_items, count }. Params: listId (required), count? (1-1000, default 10).
  • list-tagsSearch tags for a Mailchimp audience by name prefix (GET /lists/{listId}/tag-search). Returns { tags, total_items }. Params: listId (required), name? (prefix to filter, default "").
  • list-templatesList templates from Mailchimp (GET /templates). Returns { templates, total_items, count }. Params: count? (1-1000, default 10).
  • send-campaignSend a campaign in Mailchimp (POST /campaigns/{campaignId}/actions/send). The campaign must be ready to send. Returns { sent: true }. Params: campaignId (required, string).
  • update-subscriberUpdate a subscriber in a Mailchimp audience (PATCH /lists/{listId}/members/{subscriberHash}). Returns the updated subscriber. Params: listId (required), subscriberHash (required, MD5 hash of lowercase email), email_address? (new email), status? ("subscribed"|"unsubscribed"|"cleaned"|"pending"|"transactional"), merge_fields? ({ FNAME?, LNAME?, ... }).
03

Auth and permissions

What it asks for.

Declared in the manifest, in advance. The app cannot reach anything it did not ask for here.

User secrets

API_KEY

Reading further

The manifest and the source for Mailchimp live in the monorepo, alongside the other apps.

Read the sourceBack to the catalogue

Mailchimp · Agent Apps