Skip to main content

Mailchimp

Tool types for creating and sending Mailchimp campaigns, managing audience contacts, and reading engagement data — opens, clicks, and per-member activity.

Every type on this page requires a Mailchimp connector; connectorId is the ID of that connector. Campaign workflow tools follow Mailchimp's own lifecycle: create a campaign, set its content, then send or schedule it — an agent equipped with all three can run the full flow in one conversation.

Create campaign TOOLMAILCHIMP_CREATE_CAMPAIGN​

Creates a new regular email campaign targeted at an audience (list). The campaign is created empty — pair this with MAILCHIMP_SET_CAMPAIGN_CONTENT to fill it and MAILCHIMP_SEND_CAMPAIGN or MAILCHIMP_SCHEDULE_CAMPAIGN to deliver it. If title is omitted, the subject line doubles as the campaign title.

Example​

Tool config
{
  "toolType": "MAILCHIMP_CREATE_CAMPAIGN",
  "connectorId": "V1StGXR8Z5",
  "listId": "a1b2c3d4e5",
  "subjectLine": "@@{subjectLine}",
  "fromName": "Acme Weekly",
  "replyTo": "hello@acme.com"
}
This tool type requires a connected external account. Pass the connector's ID as connectorId in the tool configuration.

Configuration fields

  • Name
    connectorId
    Type
    string (ID)
    Description
    Required string (ID) value. References a connector by ID.
  • Name
    listId
    Type
    string
    Description
    Audience/List ID
  • Name
    subjectLine
    Type
    string
    Description
    Email subject
  • Name
    fromName
    Type
    string
    Description
    Sender name
  • Name
    replyTo
    Type
    string
    Description
    Reply-to email
  • Name
    title
    Type
    string · optional
    Description
    Campaign title (optional, defaults to subject)

Set campaign content TOOLMAILCHIMP_SET_CAMPAIGN_CONTENT​

Sets the body of an existing campaign. Provide either html (full HTML body) or templateId — one of the two is required, and plainText can accompany either as the text fallback. Setting content replaces whatever the campaign previously contained.

Example​

Tool config
{
  "toolType": "MAILCHIMP_SET_CAMPAIGN_CONTENT",
  "connectorId": "V1StGXR8Z5",
  "campaignId": "abc123def4",
  "html": "@@{emailHtml}",
  "plainText": "@@{emailPlainText}"
}
This tool type requires a connected external account. Pass the connector's ID as connectorId in the tool configuration.

Configuration fields

  • Name
    connectorId
    Type
    string (ID)
    Description
    Required string (ID) value. References a connector by ID.
  • Name
    campaignId
    Type
    string
    Description
    Required string value.
  • Name
    html
    Type
    string · optional
    Description
    HTML content (optional, use html or templateId)
  • Name
    plainText
    Type
    string · optional
    Description
    Plain text content (optional)
  • Name
    templateId
    Type
    string (ID) · optional
    Description
    Template ID to use (optional) References an app template by ID.

Send campaign TOOLMAILCHIMP_SEND_CAMPAIGN​

Sends a campaign to its audience immediately. This is irreversible once Mailchimp begins delivery, and it fails if the campaign has no content yet — set content first. Give this tool only to agents that are supposed to actually deliver email.

Example​

Tool config
{
  "toolType": "MAILCHIMP_SEND_CAMPAIGN",
  "connectorId": "V1StGXR8Z5",
  "campaignId": "abc123def4"
}
This tool type requires a connected external account. Pass the connector's ID as connectorId in the tool configuration.

Configuration fields

  • Name
    connectorId
    Type
    string (ID)
    Description
    Required string (ID) value. References a connector by ID.
  • Name
    campaignId
    Type
    string
    Description
    Required string value.

Schedule campaign TOOLMAILCHIMP_SCHEDULE_CAMPAIGN​

Schedules a campaign for future delivery instead of sending it now. scheduleTime is an ISO 8601 UTC timestamp (e.g. 2024-01-15T10:00:00Z); Mailchimp rounds delivery to 15-minute slots on non-premium plans.

Example​

Tool config
{
  "toolType": "MAILCHIMP_SCHEDULE_CAMPAIGN",
  "connectorId": "V1StGXR8Z5",
  "campaignId": "abc123def4",
  "scheduleTime": "@@{sendAt}"
}
This tool type requires a connected external account. Pass the connector's ID as connectorId in the tool configuration.

Configuration fields

  • Name
    connectorId
    Type
    string (ID)
    Description
    Required string (ID) value. References a connector by ID.
  • Name
    campaignId
    Type
    string
    Description
    Required string value.
  • Name
    scheduleTime
    Type
    string
    Description
    ISO 8601 format: 2024-01-15T10:00:00Z

Get campaigns TOOLMAILCHIMP_GET_CAMPAIGNS​

Lists campaigns in the account, optionally filtered by status (save, paused, schedule, sending, sent). Use count and offset to page through large accounts; the default page is 10 campaigns. This is how an agent finds the campaignId the other campaign tools need.

Example​

Tool config
{
  "toolType": "MAILCHIMP_GET_CAMPAIGNS",
  "connectorId": "V1StGXR8Z5",
  "status": "sent",
  "count": 25
}
This tool type requires a connected external account. Pass the connector's ID as connectorId in the tool configuration.

Configuration fields

  • Name
    connectorId
    Type
    string (ID)
    Description
    Required string (ID) value. References a connector by ID.
  • Name
    status
    Type
    string · optional
    Description
    Optional: save, paused, schedule, sending, sent
  • Name
    count
    Type
    integer · optional
    Description
    Optional: number of campaigns to return (default 10, max 1000)
  • Name
    offset
    Type
    integer · optional
    Description
    Optional: number of campaigns to skip (for pagination)

Get campaign report TOOLMAILCHIMP_GET_CAMPAIGN_REPORT​

Fetches the performance report for a sent campaign: sends, opens, clicks, bounces, unsubscribes, and rates. Useful for agents that summarize campaign performance or decide what to send next based on past results.

Example​

Tool config
{
  "toolType": "MAILCHIMP_GET_CAMPAIGN_REPORT",
  "connectorId": "V1StGXR8Z5",
  "campaignId": "abc123def4"
}
This tool type requires a connected external account. Pass the connector's ID as connectorId in the tool configuration.

Configuration fields

  • Name
    connectorId
    Type
    string (ID)
    Description
    Required string (ID) value. References a connector by ID.
  • Name
    campaignId
    Type
    string
    Description
    Required string value.

Get campaign content TOOLMAILCHIMP_GET_CAMPAIGN_CONTENT​

Retrieves the HTML and plain-text body of an existing campaign. Handy when an agent needs to review, quote, or adapt a previous campaign's copy before drafting a new one.

Example​

Tool config
{
  "toolType": "MAILCHIMP_GET_CAMPAIGN_CONTENT",
  "connectorId": "V1StGXR8Z5",
  "campaignId": "abc123def4"
}
This tool type requires a connected external account. Pass the connector's ID as connectorId in the tool configuration.

Configuration fields

  • Name
    connectorId
    Type
    string (ID)
    Description
    Required string (ID) value. References a connector by ID.
  • Name
    campaignId
    Type
    string
    Description
    Required string value.

Get lists TOOLMAILCHIMP_GET_LISTS​

Lists the audiences (lists) in the account with their IDs and member counts. Agents usually call this first to discover the listId that the campaign and contact tools require.

Example​

Tool config
{
  "toolType": "MAILCHIMP_GET_LISTS",
  "connectorId": "V1StGXR8Z5",
  "count": 50
}
This tool type requires a connected external account. Pass the connector's ID as connectorId in the tool configuration.

Configuration fields

  • Name
    connectorId
    Type
    string (ID)
    Description
    Required string (ID) value. References a connector by ID.
  • Name
    count
    Type
    integer · optional
    Description
    Optional: number of lists to return (default 10, max 1000)
  • Name
    offset
    Type
    integer · optional
    Description
    Optional: number of lists to skip (for pagination)

Add contact TOOLMAILCHIMP_ADD_CONTACT​

Adds a contact to an audience. status controls the subscription state — use subscribed for contacts who already opted in, or pending to trigger a double-opt-in confirmation email. Arbitrary merge fields (PHONE, ADDRESS, custom fields) go in the mergeFields object.

Example​

Tool config
{
  "toolType": "MAILCHIMP_ADD_CONTACT",
  "connectorId": "V1StGXR8Z5",
  "listId": "a1b2c3d4e5",
  "email": "@@{contactEmail}",
  "status": "subscribed",
  "firstName": "@@{firstName}",
  "lastName": "@@{lastName}"
}
This tool type requires a connected external account. Pass the connector's ID as connectorId in the tool configuration.

Configuration fields

  • Name
    connectorId
    Type
    string (ID)
    Description
    Required string (ID) value. References a connector by ID.
  • Name
    listId
    Type
    string
    Description
    Required string value.
  • Name
    email
    Type
    string
    Description
    Required string value.
  • Name
    status
    Type
    string
    Description
    subscribed, pending, unsubscribed, cleaned, transactional
  • Name
    firstName
    Type
    string · optional
    Description
    Optional
  • Name
    lastName
    Type
    string · optional
    Description
    Optional
  • Name
    mergeFields
    Type
    object · optional
    Description
    Optional: additional merge fields like PHONE, ADDRESS, etc.

Update contact TOOLMAILCHIMP_UPDATE_CONTACT​

Updates an existing contact in an audience, identified by email address (the MD5 subscriber hash Mailchimp requires is computed for you). Only the fields you supply change — omit status to leave the subscription state alone.

Example​

Tool config
{
  "toolType": "MAILCHIMP_UPDATE_CONTACT",
  "connectorId": "V1StGXR8Z5",
  "listId": "a1b2c3d4e5",
  "email": "@@{contactEmail}",
  "firstName": "@@{firstName}"
}
This tool type requires a connected external account. Pass the connector's ID as connectorId in the tool configuration.

Configuration fields

  • Name
    connectorId
    Type
    string (ID)
    Description
    Required string (ID) value. References a connector by ID.
  • Name
    listId
    Type
    string
    Description
    Required string value.
  • Name
    email
    Type
    string
    Description
    Used to identify the contact (MD5 hash computed internally)
  • Name
    status
    Type
    string · optional
    Description
    Optional: subscribed, pending, unsubscribed, cleaned, transactional
  • Name
    firstName
    Type
    string · optional
    Description
    Optional
  • Name
    lastName
    Type
    string · optional
    Description
    Optional
  • Name
    mergeFields
    Type
    object · optional
    Description
    Optional: additional merge fields

Get contacts TOOLMAILCHIMP_GET_CONTACTS​

Lists the members of an audience, optionally filtered by subscription status. Pages with count (default 10, max 1000) and offset, so an agent can walk an entire audience in batches.

Example​

Tool config
{
  "toolType": "MAILCHIMP_GET_CONTACTS",
  "connectorId": "V1StGXR8Z5",
  "listId": "a1b2c3d4e5",
  "status": "subscribed",
  "count": 100
}
This tool type requires a connected external account. Pass the connector's ID as connectorId in the tool configuration.

Configuration fields

  • Name
    connectorId
    Type
    string (ID)
    Description
    Required string (ID) value. References a connector by ID.
  • Name
    listId
    Type
    string
    Description
    Required string value.
  • Name
    status
    Type
    string · optional
    Description
    Optional: subscribed, pending, unsubscribed, cleaned, transactional
  • Name
    count
    Type
    integer · optional
    Description
    Optional: number of contacts to return (default 10, max 1000)
  • Name
    offset
    Type
    integer · optional
    Description
    Optional: number of contacts to skip (for pagination)

List email clickers TOOLMAILCHIMP_LIST_EMAIL_CLICKERS​

Returns the contacts who clicked links in a campaign. With campaignId it reports on that single campaign; without it, the tool scans the most recent sent campaigns (up to count, default 10) and aggregates clickers across them. Results are cached briefly, so back-to-back calls don't rescan the account.

Example​

Tool config
{
  "toolType": "MAILCHIMP_LIST_EMAIL_CLICKERS",
  "connectorId": "V1StGXR8Z5",
  "campaignId": "abc123def4"
}
This tool type requires a connected external account. Pass the connector's ID as connectorId in the tool configuration.

Configuration fields

  • Name
    connectorId
    Type
    string (ID)
    Description
    Required string (ID) value. References a connector by ID.
  • Name
    campaignId
    Type
    string · optional
    Description
    Optional: if provided, only get clickers for this campaign
  • Name
    count
    Type
    integer · optional
    Description
    Optional: max campaigns when campaignId is null (default 10)

List contacts with clicked campaigns TOOLMAILCHIMP_LIST_CONTACTS_WITH_CLICKED_CAMPAIGNS​

Cross-references an audience against recent campaign click activity, returning each contact together with the campaigns they clicked. campaignCount bounds how many recent sent campaigns are scanned (default 10), while count and offset page through the audience itself. Good for building engaged-segment lists for follow-up.

Example​

Tool config
{
  "toolType": "MAILCHIMP_LIST_CONTACTS_WITH_CLICKED_CAMPAIGNS",
  "connectorId": "V1StGXR8Z5",
  "listId": "a1b2c3d4e5",
  "campaignCount": 10
}
This tool type requires a connected external account. Pass the connector's ID as connectorId in the tool configuration.

Configuration fields

  • Name
    connectorId
    Type
    string (ID)
    Description
    Required string (ID) value. References a connector by ID.
  • Name
    listId
    Type
    string
    Description
    Required string value.
  • Name
    campaignCount
    Type
    integer · optional
    Description
    Optional: max sent campaigns to scan (default 10)
  • Name
    offset
    Type
    integer · optional
    Description
    Optional: pagination offset (default 0)
  • Name
    count
    Type
    integer · optional
    Description
    Optional: contacts per page (default 1000)

Get member click activity TOOLMAILCHIMP_GET_MEMBER_CLICK_ACTIVITY​

Looks up the click history of a single contact by email address. Supplying listId lets the tool fetch the member's profile and use the richer per-member activity feed; without it, activity is resolved from campaign click reports. Use this when an agent needs to answer "what has this specific person engaged with?"

Example​

Tool config
{
  "toolType": "MAILCHIMP_GET_MEMBER_CLICK_ACTIVITY",
  "connectorId": "V1StGXR8Z5",
  "email": "@@{contactEmail}",
  "listId": "a1b2c3d4e5"
}
This tool type requires a connected external account. Pass the connector's ID as connectorId in the tool configuration.

Configuration fields

  • Name
    connectorId
    Type
    string (ID)
    Description
    Required string (ID) value. References a connector by ID.
  • Name
    email
    Type
    string
    Description
    Required: email address to look up
  • Name
    listId
    Type
    string · optional
    Description
    Optional: if provided, fetches member info and uses activity-feed endpoint

List email openers TOOLMAILCHIMP_LIST_EMAIL_OPENERS​

Returns the contacts who opened a campaign, with open counts. Like the clickers tool, it works in single-campaign mode when campaignId is set, or scans the most recent sent campaigns (up to count) when it isn't. Note that Apple Mail privacy features inflate open counts — clicks are the more reliable engagement signal.

Example​

Tool config
{
  "toolType": "MAILCHIMP_LIST_EMAIL_OPENERS",
  "connectorId": "V1StGXR8Z5",
  "campaignId": "abc123def4"
}
This tool type requires a connected external account. Pass the connector's ID as connectorId in the tool configuration.

Configuration fields

  • Name
    connectorId
    Type
    string (ID)
    Description
    Required string (ID) value. References a connector by ID.
  • Name
    campaignId
    Type
    string · optional
    Description
    Optional: if provided, only get openers for this campaign
  • Name
    count
    Type
    integer · optional
    Description
    Optional: max campaigns when campaignId is null (default 10)