# Mailchimp

Your Toolhouse AI Worker can connect to Mailchimp using 275 specialized tools.

## Auth Connection

This service requires an auth connection to use its tools. You can set this up in your Toolhouse dashboard under [Auth Connections](https://toolhouse.app/auth-connections?authkit_slugs=mailchimp).

## Tools (275)

### `Mailchimp Add Automation`

Integration name: **MAILCHIMP\_ADD\_AUTOMATION**

Create a new classic abandoned cart automation in your Mailchimp account. This action creates an automation workflow that sends emails to customers who have abandoned their shopping cart. Requires a connected e-commerce store and an audience/list. Prerequisites:

* A Mailchimp audience/list (use MAILCHIMP\_ADD\_LIST or MAILCHIMP\_GET\_LISTS\_INFO)
* A connected e-commerce store (use MAILCHIMP\_ADD\_STORE or MAILCHIMP\_LIST\_STORES)

Note: Classic automations are only available to paid Mailchimp accounts that have previously created a classic automation. Currently only the `abandonedCart` workflow type is supported via the API.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter                           | Type   | Required | Example | Description                                                                                                                                                                    |
| ----------------------------------- | ------ | :------: | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `settings__reply__to`               | string |          | —       | The email address that recipients can reply to (e.g., '<support@yourcompany.com>').                                                                                            |
| `recipients__list__id`              | string |     ✅    | —       | The unique ID of the Mailchimp audience/list that this automation will target. Required for creating an automation. Get this from MAILCHIMP\_GET\_LISTS\_INFO.                 |
| `settings__from__name`              | string |          | —       | The sender name that appears in the "From" field of automation emails (e.g., 'Your Company Name'). Not an email address.                                                       |
| `recipients__store__id`             | string |          | —       | The unique ID of the connected e-commerce store. Required for abandonedCart workflow type to enable cart tracking. Get this from MAILCHIMP\_LIST\_STORES.                      |
| `trigger__settings__workflow__type` | string |          | —       | The type of classic automation workflow to create. Currently only 'abandonedCart' is supported via the API. This triggers emails when a customer abandons their shopping cart. |

***

### `Mailchimp Add Batch Webhook`

Integration name: **MAILCHIMP\_ADD\_BATCH\_WEBHOOK**

Configure a webhook that will fire whenever any batch request completes processing. You may only have a maximum of 20 batch webhooks.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type    | Required | Example | Description                                                                                                                                                   |
| --------- | ------- | :------: | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url`     | string  |     ✅    | —       | A valid URL for the batch webhook. Mailchimp will POST data to this URL when a batch operation completes processing. Must be a publicly accessible HTTPS URL. |
| `enabled` | boolean |          | —       | Whether the webhook should be enabled to receive requests. Defaults to True if not specified.                                                                 |

***

### `Mailchimp Add Campaign`

Integration name: **MAILCHIMP\_ADD\_CAMPAIGN**

Create a new Mailchimp campaign.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter                                       | Type    | Required | Example | Description                                                                                                                                                                                                                                                                                                                                                                                                             |
| ----------------------------------------------- | ------- | :------: | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type`                                          | string  |     ✅    | —       | There are four types of [campaigns](https://mailchimp.com/help/getting-started-with-campaigns/) you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead.                                                                                                                                                                                                     |
| `content_type`                                  | string  |          | —       | How the campaign"s content is put together. The old drag and drop editor uses "template" while the new editor uses "multichannel". Defaults to template.                                                                                                                                                                                                                                                                |
| `settings__title`                               | string  |          | —       | The title of the campaign.                                                                                                                                                                                                                                                                                                                                                                                              |
| `tracking__opens`                               | boolean |          | —       | Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns.                                                                                                                                                                                                                                                                            |
| `settings__to__name`                            | string  |          | —       | The campaign"s custom "To" name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/).                                                                                                                                                                                                                                                                                |
| `tracking__ecomm360`                            | boolean |          | —       | Whether to enable e-commerce tracking.                                                                                                                                                                                                                                                                                                                                                                                  |
| `settings__reply__to`                           | string  |          | —       | The reply-to email address for the campaign. Note: while this field is not required for campaign creation, it is required for sending.                                                                                                                                                                                                                                                                                  |
| `social__card__title`                           | string  |          | —       | The title for the card. Typically the subject line of the campaign.                                                                                                                                                                                                                                                                                                                                                     |
| `tracking__clicktale`                           | string  |          | —       | The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes).                                                                                                                                                                                                                                                                                      |
| `recipients__list__id`                          | string  |          | —       | The unique list id.                                                                                                                                                                                                                                                                                                                                                                                                     |
| `rss__opts__feed__url`                          | string  |          | —       | The URL for the RSS feed.                                                                                                                                                                                                                                                                                                                                                                                               |
| `rss__opts__frequency`                          | string  |          | —       | The frequency of the RSS Campaign.                                                                                                                                                                                                                                                                                                                                                                                      |
| `settings__folder__id`                          | string  |          | —       | If the campaign is listed in a folder, the id for that folder.                                                                                                                                                                                                                                                                                                                                                          |
| `settings__from__name`                          | string  |          | —       | The "from" name on the campaign (not an email address).                                                                                                                                                                                                                                                                                                                                                                 |
| `settings__auto__tweet`                         | boolean |          | —       | Automatically tweet a link to the [campaign archive](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) page when the campaign is sent.                                                                                                                                                                                                                                                               |
| `settings__inline__css`                         | boolean |          | —       | Automatically inline the CSS included with the campaign content.                                                                                                                                                                                                                                                                                                                                                        |
| `settings__authenticate`                        | boolean |          | —       | Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`.                                                                                                                                                                                                                                                                                             |
| `settings__auto__footer`                        | boolean |          | —       | Automatically append Mailchimp"s [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign.                                                                                                                                                                                                                                                                                                  |
| `settings__fb__comments`                        | boolean |          | —       | Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`.                                                                                                                                                                                                                                                                                                         |
| `settings__template__id`                        | integer |          | —       | The id of the template to use.                                                                                                                                                                                                                                                                                                                                                                                          |
| `tracking__html__clicks`                        | boolean |          | —       | Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns.                                                                                                                                                                                                                            |
| `tracking__text__clicks`                        | boolean |          | —       | Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns.                                                                                                                                                                                                                      |
| `settings__preview__text`                       | string  |          | —       | The preview text for the campaign.                                                                                                                                                                                                                                                                                                                                                                                      |
| `settings__subject__line`                       | string  |          | —       | The subject line for the campaign.                                                                                                                                                                                                                                                                                                                                                                                      |
| `settings__auto__fb__post`                      | array   |          | —       | An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to.                                                                                                                                                                                                                                                                                            |
| `social__card__image__url`                      | string  |          | —       | The url for the header image for the card.                                                                                                                                                                                                                                                                                                                                                                              |
| `tracking__capsule__notes`                      | boolean |          | —       | Update contact notes for a campaign based on subscriber email addresses.                                                                                                                                                                                                                                                                                                                                                |
| `tracking__goal__tracking`                      | boolean |          | —       | Deprecated                                                                                                                                                                                                                                                                                                                                                                                                              |
| `rss__opts__schedule__hour`                     | integer |          | —       | The hour to send the campaign in local time. Acceptable hours are 0-23. For example, "4" would be 4am in [your account"s default time zone](https://mailchimp.com/help/set-account-defaults/).                                                                                                                                                                                                                          |
| `social__card__description`                     | string  |          | —       | A short summary of the campaign to display.                                                                                                                                                                                                                                                                                                                                                                             |
| `settings__use__conversation`                   | boolean |          | —       | Use Mailchimp Conversation feature to manage out-of-office replies.                                                                                                                                                                                                                                                                                                                                                     |
| `tracking__google__analytics`                   | string  |          | —       | The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes).                                                                                                                                                                                                                                                                               |
| `tracking__salesforce__notes`                   | boolean |          | —       | Update contact notes for a campaign based on subscriber email addresses.                                                                                                                                                                                                                                                                                                                                                |
| `variate__settings__test__size`                 | integer |          | —       | The percentage of recipients to send the test combinations to, must be a value between 10 and 100.                                                                                                                                                                                                                                                                                                                      |
| `variate__settings__wait__time`                 | integer |          | —       | The number of minutes to wait before choosing the winning campaign. The value of wait\_time must be greater than 0 and in whole hours, specified in minutes.                                                                                                                                                                                                                                                            |
| `rss__opts__constrain__rss__img`                | boolean |          | —       | Whether to add CSS to images in the RSS feed to constrain their width in campaigns.                                                                                                                                                                                                                                                                                                                                     |
| `tracking__salesforce__campaign`                | boolean |          | —       | Create a campaign in a connected Salesforce account.                                                                                                                                                                                                                                                                                                                                                                    |
| `variate__settings__from__names`                | array   |          | —       | The possible from names. The number of from\_names provided must match the number of reply\_to\_addresses. If no from\_names are provided, settings.from\_name will be used.                                                                                                                                                                                                                                            |
| `variate__settings__send__times`                | array   |          | —       | The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send\_times are provided to test, the test\_size will be set to 100% and winner\_criteria will be ignored.                                                                                                                                                                                                          |
| `recipients__segment__opts__match`              | string  |          | —       | Segment match type.                                                                                                                                                                                                                                                                                                                                                                                                     |
| `variate__settings__subject__lines`             | array   |          | —       | The possible subject lines to test. If no subject lines are provided, settings.subject\_line will be used.                                                                                                                                                                                                                                                                                                              |
| `variate__settings__winner__criteria`           | string  |          | —       | The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue -- or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send\_time, winner\_criteria is ignored. For Multivariate Campaigns with "manual" as the winner\_criteria, the winner must be chosen in the Mailchimp web application. |
| `recipients__segment__opts__conditions`         | array   |          | —       | Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas).                                                                                                                                                                                                                    |
| `rss__opts__schedule__weekly__send__day`        | string  |          | —       | The day of the week to send a weekly RSS Campaign.                                                                                                                                                                                                                                                                                                                                                                      |
| `variate__settings__reply__to__addresses`       | array   |          | —       | The possible reply-to addresses. The number of reply\_to\_addresses provided must match the number of from\_names. If no reply\_to\_addresses are provided, settings.reply\_to will be used.                                                                                                                                                                                                                            |
| `rss__opts__schedule__daily__send__friday`      | boolean |          | —       | Sends the daily RSS Campaign on Fridays.                                                                                                                                                                                                                                                                                                                                                                                |
| `rss__opts__schedule__daily__send__monday`      | boolean |          | —       | Sends the daily RSS Campaign on Mondays.                                                                                                                                                                                                                                                                                                                                                                                |
| `rss__opts__schedule__daily__send__sunday`      | boolean |          | —       | Sends the daily RSS Campaign on Sundays.                                                                                                                                                                                                                                                                                                                                                                                |
| `rss__opts__schedule__monthly__send__date`      | integer |          | —       | The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where "0" is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February.                                                                                                         |
| `rss__opts__schedule__daily__send__tuesday`     | boolean |          | —       | Sends the daily RSS Campaign on Tuesdays.                                                                                                                                                                                                                                                                                                                                                                               |
| `rss__opts__schedule__daily__send__saturday`    | boolean |          | —       | Sends the daily RSS Campaign on Saturdays.                                                                                                                                                                                                                                                                                                                                                                              |
| `rss__opts__schedule__daily__send__thursday`    | boolean |          | —       | Sends the daily RSS Campaign on Thursdays.                                                                                                                                                                                                                                                                                                                                                                              |
| `rss__opts__schedule__daily__send__wednesday`   | boolean |          | —       | Sends the daily RSS Campaign on Wednesdays.                                                                                                                                                                                                                                                                                                                                                                             |
| `recipients__segment__opts__saved__segment__id` | integer |          | —       | The id for an existing saved segment.                                                                                                                                                                                                                                                                                                                                                                                   |

***

### `Mailchimp Add Campaign Feedback`

Integration name: **MAILCHIMP\_ADD\_CAMPAIGN\_FEEDBACK**

Add feedback on a specific Mailchimp campaign. Use this to post comments, notes, or feedback while collaborating on a campaign with your team. The feedback can be associated with a specific content block or applied to the campaign as a whole.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter     | Type    | Required | Example | Description                                                                                                                     |
| ------------- | ------- | :------: | ------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `message`     | string  |     ✅    | —       | The content of the feedback message. This is the text of the feedback comment.                                                  |
| `block_id`    | integer |          | —       | The block ID for the editable block that the feedback addresses. Optional - omit if providing general feedback on the campaign. |
| `campaign_id` | string  |     ✅    | —       | The unique ID for the campaign. You can get this from the List Campaigns endpoint or when creating a campaign.                  |
| `is_complete` | boolean |          | —       | Whether the feedback item is complete. Set to true to mark as resolved, false otherwise. Defaults to false if not provided.     |

***

### `Mailchimp Add Campaign Folder`

Integration name: **MAILCHIMP\_ADD\_CAMPAIGN\_FOLDER**

Create a new campaign folder to organize email campaigns in Mailchimp. Campaign folders help organize your email marketing campaigns into logical groups. Returns the created folder's ID, name, and initial campaign count (0).

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type   | Required | Example | Description                                                                                          |
| --------- | ------ | :------: | ------- | ---------------------------------------------------------------------------------------------------- |
| `name`    | string |     ✅    | —       | The name for the new campaign folder. This is used to organize campaigns in the Mailchimp interface. |

***

### `Mailchimp Add Cart`

Integration name: **MAILCHIMP\_ADD\_CART**

Add a new cart to a store.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter                           | Type    | Required | Example | Description                                                                                                                                                                                                                                                                                                                                                                                                        |
| ----------------------------------- | ------- | :------: | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `id`                                | string  |     ✅    | —       | A unique identifier for the cart.                                                                                                                                                                                                                                                                                                                                                                                  |
| `lines`                             | array   |     ✅    | —       | An array of the cart's line items. Each line item must include: 'id' (unique identifier for the line item), 'product\_id' (ID of the product in your store), 'product\_variant\_id' (ID of the product variant), 'quantity' (number of items), and 'price' (price of the item as a number). Example: \[{'id': 'line1', 'product\_id': 'prod123', 'product\_variant\_id': 'var123', 'quantity': 1, 'price': 29.99}] |
| `store_id`                          | string  |     ✅    | —       | The unique identifier for the e-commerce store. Must be an existing store ID in your Mailchimp account.                                                                                                                                                                                                                                                                                                            |
| `tax_total`                         | number  |          | —       | The total tax amount for the cart. Optional field that can be used to track tax separately.                                                                                                                                                                                                                                                                                                                        |
| `campaign_id`                       | string  |          | —       | A string that uniquely identifies the campaign for a cart.                                                                                                                                                                                                                                                                                                                                                         |
| `order_total`                       | number  |     ✅    | —       | The total price for all items in the cart. This should be the sum of all line item prices multiplied by their quantities.                                                                                                                                                                                                                                                                                          |
| `checkout_url`                      | string  |          | —       | The URL for the cart. This parameter is required for [Abandoned Cart](https://mailchimp.com/help/create-an-abandoned-cart-email/) automations.                                                                                                                                                                                                                                                                     |
| `customer__id`                      | string  |     ✅    | —       | A unique identifier for the customer who owns this cart. Limited to 50 characters. Required field.                                                                                                                                                                                                                                                                                                                 |
| `currency_code`                     | string  |     ✅    | —       | The three-letter ISO 4217 currency code (e.g., 'USD', 'EUR', 'GBP'). Must match the currency configured for the store.                                                                                                                                                                                                                                                                                             |
| `customer__company`                 | string  |          | —       | The customer's company name.                                                                                                                                                                                                                                                                                                                                                                                       |
| `customer__last__name`              | string  |          | —       | The customer's last name.                                                                                                                                                                                                                                                                                                                                                                                          |
| `customer__first__name`             | string  |          | —       | The customer's first name.                                                                                                                                                                                                                                                                                                                                                                                         |
| `customer__address__city`           | string  |          | —       | The city the customer is located in.                                                                                                                                                                                                                                                                                                                                                                               |
| `customer__email__address`          | string  |     ✅    | —       | Required. The customer's email address. Must be a valid, real email address.                                                                                                                                                                                                                                                                                                                                       |
| `customer__opt__in__status`         | boolean |     ✅    | —       | Required. The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list will be added as Transactional members.                                                                                                   |
| `customer__address__country`        | string  |          | —       | The customer's country.                                                                                                                                                                                                                                                                                                                                                                                            |
| `customer__address__address1`       | string  |          | —       | The mailing address of the customer.                                                                                                                                                                                                                                                                                                                                                                               |
| `customer__address__address2`       | string  |          | —       | An additional field for the customer's mailing address.                                                                                                                                                                                                                                                                                                                                                            |
| `customer__address__province`       | string  |          | —       | The customer's state name or normalized province.                                                                                                                                                                                                                                                                                                                                                                  |
| `customer__address__postal__code`   | string  |          | —       | The customer's postal or zip code.                                                                                                                                                                                                                                                                                                                                                                                 |
| `customer__address__country__code`  | string  |          | —       | The two-letter ISO country code for the customer's country (e.g., 'US', 'DE').                                                                                                                                                                                                                                                                                                                                     |
| `customer__address__province__code` | string  |          | —       | The two-letter code for the customer's province or state.                                                                                                                                                                                                                                                                                                                                                          |

***

### `Mailchimp Add Cart Line Item`

Integration name: **MAILCHIMP\_ADD\_CART\_LINE\_ITEM**

Add a new line item to an existing cart.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter            | Type    | Required | Example | Description                                                                                      |
| -------------------- | ------- | :------: | ------- | ------------------------------------------------------------------------------------------------ |
| `id`                 | string  |     ✅    | —       | A unique identifier for the cart line item. Must be unique within the cart.                      |
| `price`              | number  |     ✅    | —       | The price per unit for the cart line item in the store's currency.                               |
| `cart_id`            | string  |     ✅    | —       | The unique identifier for the cart to add the line item to.                                      |
| `quantity`           | integer |     ✅    | —       | The quantity of this product variant to add to the cart. Must be a positive integer.             |
| `store_id`           | string  |     ✅    | —       | The unique identifier for the e-commerce store.                                                  |
| `product_id`         | string  |     ✅    | —       | The unique identifier for the product. The product must already exist in the store.              |
| `product_variant_id` | string  |     ✅    | —       | The unique identifier for the product variant. The variant must exist for the specified product. |

***

### `Mailchimp Add Connected Site`

Integration name: **MAILCHIMP\_ADD\_CONNECTED\_SITE**

Create a new Mailchimp connected site. Connected sites allow you to track website visitor activity and integrate with Mailchimp's marketing features. After adding a connected site, you'll receive a tracking script (site\_script) that should be installed on your website to enable visitor tracking.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter    | Type   | Required | Example | Description                                                                                                                                                            |
| ------------ | ------ | :------: | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `domain`     | string |     ✅    | —       | The full domain name of the connected site (e.g., 'example.com' or 'shop.mystore.com'). This is the website URL where the Mailchimp tracking script will be installed. |
| `foreign_id` | string |     ✅    | —       | A unique identifier for the connected site that you define. This ID is used to reference the site in subsequent API calls. Example: 'my-website-001' or 'store-12345'. |

***

### `Mailchimp Add Contact To Audience`

Integration name: **MAILCHIMP\_ADD\_CONTACT\_TO\_AUDIENCE**

Tool to create a new omni-channel contact in a Mailchimp audience. Use when adding contacts with email and/or SMS channels to an audience.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter                     | Type   | Required | Example                          | Description                                                                                                                                                                                            |
| ----------------------------- | ------ | :------: | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `tags`                        | array  |          | `["new_tag","another_tag"]`      | An array of tag names to add to the contact. This operation is append-only; existing tags will be preserved, and only new tags from this array will be added.                                          |
| `language`                    | string |          | `"en"`                           | The subscriber's language preference as a two-letter ISO 639-1 code (e.g., 'en', 'es', 'fr').                                                                                                          |
| `data_mode`                   | string |          | —                                | Data processing mode.                                                                                                                                                                                  |
| `audience_id`                 | string |     ✅    | `"773280e405"`                   | The unique ID for the audience. Get this from the Mailchimp account or via the list audiences endpoint.                                                                                                |
| `sms_channel`                 | object |          | —                                | SMS channel details for a contact.                                                                                                                                                                     |
| `merge_fields`                | object |          | `{"FNAME":"John","LNAME":"Doe"}` | A dictionary of merge fields where the keys are the merge tags (like FNAME, LNAME). Values are strings representing the field values. See the Merge Fields documentation for more about the structure. |
| `email_channel`               | object |          | —                                | Email channel details for a contact.                                                                                                                                                                   |
| `merge_field_validation_mode` | string |          | —                                | Merge field validation mode.                                                                                                                                                                           |

***

### `Mailchimp Add Domain To Account`

Integration name: **MAILCHIMP\_ADD\_DOMAIN\_TO\_ACCOUNT**

Add a sending domain to the Mailchimp account for email verification. This action adds a new domain to your Mailchimp account and initiates the verification process by sending a verification code to the specified email address. After calling this action, use the 'verify\_domain' action with the received verification code to complete the domain verification process.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter            | Type   | Required | Example | Description                                                                                                                                                                                                                                             |
| -------------------- | ------ | :------: | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `verification_email` | string |     ✅    | —       | The email address at the domain you want to verify (e.g., '<admin@yourdomain.com>'). A verification code will be sent to this email address to confirm domain ownership. You must have access to this email inbox to complete the verification process. |

***

### `Mailchimp Add Event`

Integration name: **MAILCHIMP\_ADD\_EVENT**

Add an event for a list member. Use this action to track contact activity and behavior outside of email campaigns. Events can be used for segmentation and triggering automation workflows. Common use cases:

* Track purchases, signups, or page visits
* Record custom milestones or achievements
* Import historical events with is\_syncing=true to avoid triggering automations

Note: Returns 204 No Content on success (empty response body).

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter         | Type    | Required | Example | Description                                                                                                                                                                   |
| ----------------- | ------- | :------: | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name`            | string  |     ✅    | —       | The name for this type of event (e.g., 'purchased', 'visited', 'signup\_completed'). Must be 2-30 characters in length. Use lowercase letters, numbers, and underscores only. |
| `list_id`         | string  |     ✅    | —       | The unique ID for the Mailchimp list/audience.                                                                                                                                |
| `is_syncing`      | boolean |          | —       | Set to true to prevent this event from triggering automations. Useful when bulk-importing historical events.                                                                  |
| `properties`      | object  |          | —       | Optional key-value pairs of custom properties for the event. Example: {'product\_name': 'T-Shirt', 'price': '29.99'}. Property names must be 2-30 characters.                 |
| `occurred_at`     | string  |          | —       | The date and time the event occurred in ISO 8601 format (e.g., '2024-01-15T10:30:00Z'). Defaults to current time if not specified.                                            |
| `subscriber_hash` | string  |     ✅    | —       | The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact\_id.                            |

***

### `Mailchimp Add Export`

Integration name: **MAILCHIMP\_ADD\_EXPORT**

Create a new account export in your Mailchimp account. This action initiates an export of your Mailchimp account data as a downloadable ZIP file. The export runs in the background and may take from a few minutes to several hours depending on account size. Use the 'get\_account\_export\_info' action with the returned export\_id to check progress and retrieve the download URL. Important limitations:

* Only one export can run at a time per account
* Only one export can be created per 24-hour period
* Completed exports are available for download for 90 days

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter         | Type   | Required | Example | Description                                                                                                                                                                                                                                                                                                                                                                                                                  |
| ----------------- | ------ | :------: | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `include_stages`  | array  |     ✅    | —       | The types of data to include in the export. At least one stage is required. Available stages: 'audiences' (contact lists and segments), 'campaigns' (email campaign content), 'events' (contact activity events), 'gallery\_files' (uploaded images and files), 'reports' (campaign performance reports), 'templates' (email template designs). Example: \['audiences', 'campaigns'] to export both audiences and campaigns. |
| `since_timestamp` | string |          | —       | Optional ISO 8601 timestamp to limit the export to data created after this time. Format: YYYY-MM-DDTHH:MM:SS+00:00 (e.g., '2024-01-15T00:00:00+00:00'). Note: This limit does NOT apply to audiences - all audience data is always included. Useful for incremental exports when you only need recent campaign reports or events.                                                                                            |

***

### `Mailchimp Add File`

Integration name: **MAILCHIMP\_ADD\_FILE**

Upload a new image or file to the Mailchimp File Manager. Use this action to upload files (images, documents, etc.) that can be used in campaigns, templates, or signup forms. The file must be base64-encoded and under 10MB. Supported image types: jpg, jpeg, gif, png, svg. Supported document types: pdf, txt, csv, and more. The uploaded file will be available at the returned full\_size\_url for use in your content.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter   | Type    | Required | Example | Description                                                                                                                                                             |
| ----------- | ------- | :------: | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name`      | string  |     ✅    | —       | The name of the file including extension (e.g., 'image.png', 'document.pdf'). This will be the display name in the File Manager.                                        |
| `file_data` | string  |     ✅    | —       | The base64-encoded contents of the file to upload. The file must be a supported type (images: jpg, jpeg, gif, png, svg; documents: pdf, txt, csv, etc.) and under 10MB. |
| `folder_id` | integer |          | —       | The ID of the folder to upload the file to. If not provided, the file will be uploaded to the root folder.                                                              |

***

### `Mailchimp Add Folder`

Integration name: **MAILCHIMP\_ADD\_FOLDER**

Create a new folder in the File Manager to organize uploaded files. Use this action to create organizational folders in the Mailchimp File Manager. Folders help organize images and other files that can be used in campaigns and templates.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter    | Type    | Required | Example | Description                                                                              |
| ------------ | ------- | :------: | ------- | ---------------------------------------------------------------------------------------- |
| `name`       | string  |     ✅    | —       | The name of the folder to create in the File Manager. Must be unique within the account. |
| `created_at` | string  |          | —       | The date and time the folder was created in ISO 8601 format.                             |
| `created_by` | string  |          | —       | The username of the profile that created the folder.                                     |
| `file_count` | integer |          | —       | The number of files in the folder.                                                       |

***

### `Mailchimp Add Interest Category`

Integration name: **MAILCHIMP\_ADD\_INTEREST\_CATEGORY**

Create a new interest category.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter       | Type    | Required | Example | Description                                                                                                                                                                                                                               |
| --------------- | ------- | :------: | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type`          | string  |     ✅    | —       | Determines how this category's interests appear on signup forms. Options: 'checkboxes' (multiple selection), 'dropdown' (single selection from dropdown), 'radio' (single selection from radio buttons), 'hidden' (not visible on forms). |
| `title`         | string  |     ✅    | —       | The text description of this category. This field appears on signup forms and is often phrased as a question (e.g., 'What topics interest you?').                                                                                         |
| `list_id`       | string  |     ✅    | —       | The unique ID for the list/audience to add the interest category to.                                                                                                                                                                      |
| `display_order` | integer |          | —       | The order that the categories are displayed in the list. Lower numbers display first. Defaults to 0 if not specified.                                                                                                                     |

***

### `Mailchimp Add Interest In Category`

Integration name: **MAILCHIMP\_ADD\_INTEREST\_IN\_CATEGORY**

Create a new interest or 'group name' for a specific category.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter              | Type    | Required | Example | Description                                                                                                                               |
| ---------------------- | ------- | :------: | ------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `name`                 | string  |     ✅    | —       | The name of the interest (group name). This is shown publicly on subscription forms and used to group subscribers by their preferences.   |
| `list_id`              | string  |     ✅    | —       | The unique ID for the Mailchimp list/audience (e.g., 'abc123def4').                                                                       |
| `display_order`        | integer |          | —       | The display order for this interest within the category. Lower numbers display first. If not specified, the interest is added at the end. |
| `interest_category_id` | string  |     ✅    | —       | The unique ID for the interest category (group) where the interest will be added (e.g., 'xyz789ghi0').                                    |

***

### `Mailchimp Add Landing Page`

Integration name: **MAILCHIMP\_ADD\_LANDING\_PAGE**

Create a new Mailchimp landing page. Creates an unpublished landing page that can be customized and published later. Requires either a list\_id or use\_default\_list=true. The landing page type can be 'signup' (for email list signups) or 'product' (for product promotions, requires store\_id).

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter                                        | Type    | Required | Example | Description                                                                                                                                                      |
| ------------------------------------------------ | ------- | :------: | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name`                                           | string  |          | —       | The internal name of this landing page (for your reference, not visible to visitors).                                                                            |
| `type`                                           | string  |          | —       | The type of landing page template: 'signup' for email list signups, or 'product' for product promotions.                                                         |
| `title`                                          | string  |          | —       | The title of this landing page displayed in the browser's title bar.                                                                                             |
| `list_id`                                        | string  |          | —       | The audience/list ID to associate with this landing page. Either list\_id or use\_default\_list=true must be provided.                                           |
| `store_id`                                       | string  |          | —       | The ID of the e-commerce store to associate with this landing page. Required for 'product' type pages.                                                           |
| `description`                                    | string  |          | —       | A brief description of this landing page for internal reference.                                                                                                 |
| `template_id`                                    | integer |          | —       | The specific template ID to use for this landing page. If not provided, a default template is used.                                                              |
| `use_default_list`                               | boolean |          | —       | If true, creates the landing page using the account's default list instead of requiring a list\_id. Either list\_id or use\_default\_list=true must be provided. |
| `tracking__track__with__mailchimp`               | boolean |          | —       | Enable Mailchimp cookie tracking to monitor unique visitors and calculate conversion rates.                                                                      |
| `tracking__enable__restricted__data__processing` | boolean |          | —       | Enable Google's restricted data processing for CCPA compliance, limiting how Google uses certain identifiers and data in its services.                           |

***

### `Mailchimp Add List`

Integration name: **MAILCHIMP\_ADD\_LIST**

Create a new audience (list) in your Mailchimp account. This endpoint creates a new audience/list for managing email contacts. Each audience has unique settings for campaigns, permissions, and contact information. Note: Free Mailchimp accounts are limited to 1 audience. Paid plans allow multiple audiences. Required fields include: name, contact information (company, address1, city, country), permission\_reminder, and campaign defaults (from\_name, from\_email, subject, language).

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter                         | Type    | Required | Example | Description                                                                                                                                                              |
| --------------------------------- | ------- | :------: | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `name`                            | string  |     ✅    | —       | The name of the audience/list. Must be unique within your Mailchimp account.                                                                                             |
| `contact__zip`                    | string  |          | —       | The postal or zip code for the list contact (optional).                                                                                                                  |
| `double_optin`                    | boolean |          | —       | Whether to require double opt-in (subscriber must confirm via email). Recommended for GDPR compliance. Defaults to false.                                                |
| `contact__city`                   | string  |     ✅    | —       | The city for the list contact. Required.                                                                                                                                 |
| `contact__phone`                  | string  |          | —       | The phone number for the list contact. Optional.                                                                                                                         |
| `contact__state`                  | string  |          | —       | The state or province for the list contact (optional).                                                                                                                   |
| `use_archive_bar`                 | boolean |          | —       | Whether campaigns for this list use the Archive Bar in archives by default. Defaults to false.                                                                           |
| `contact__company`                | string  |     ✅    | —       | The company name for the list. Required.                                                                                                                                 |
| `contact__country`                | string  |     ✅    | —       | A two-character ISO3166 country code (e.g., 'US', 'GB', 'CA'). Required.                                                                                                 |
| `contact__address1`               | string  |     ✅    | —       | The street address for the list contact. Required.                                                                                                                       |
| `contact__address2`               | string  |          | —       | The secondary street address for the list contact (optional).                                                                                                            |
| `email_type_option`               | boolean |          | —       | Whether subscribers can choose their email format (HTML vs plain-text). When true, subscribers choose their format. When false, all receive HTML with plain-text backup. |
| `notify_on_subscribe`             | string  |          | —       | Email address to send subscribe notifications to. Provide a valid email address or omit to disable notifications.                                                        |
| `permission_reminder`             | string  |     ✅    | —       | The permission reminder explaining why contacts are receiving emails from this list. Example: 'You are receiving this email because you opted in via our website.'       |
| `marketing_permissions`           | boolean |          | —       | Whether to enable GDPR-friendly marketing permissions. Defaults to false.                                                                                                |
| `notify_on_unsubscribe`           | string  |          | —       | Email address to send unsubscribe notifications to. Provide a valid email address or omit to disable notifications.                                                      |
| `campaign__defaults__subject`     | string  |     ✅    | —       | The default subject line for campaigns sent to this list. Required.                                                                                                      |
| `campaign__defaults__language`    | string  |     ✅    | —       | The default language for this list's forms (e.g., 'en' for English). Required.                                                                                           |
| `campaign__defaults__from__name`  | string  |     ✅    | —       | The default 'From' name for campaigns sent to this list. Required.                                                                                                       |
| `campaign__defaults__from__email` | string  |     ✅    | —       | The default 'From' email address for campaigns sent to this list. Required.                                                                                              |

***

This page continues with the remaining Mailchimp tool entries in the same format.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.toolhouse.ai/toolhouse/integrations/mailchimp.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
