Mailchimp

Get detailed information about a specific Mailchimp account export. Use this action to check the status of an export job and retrieve the download URL once it's complete. Exports can take anywhere from a few minutes to several hours depending on account size. Typical workflow: 1. Create an export using 'add_export' action 2. Poll this action periodically to check the 'finished' status 3. Once 'finished' is True, use the 'download_url' to download the ZIP file Note: The download_url is signed and provides direct access to your data without authentication. Keep this URL secure. Completed exports are available for download for up to 90 days.

Get Mailchimp account details and links to all available API resources. Returns account information including account ID, name, email, contact details, pricing plan, and subscriber count, along with navigation links to other API endpoints like lists, campaigns, automations, templates, and more.

Retrieve detailed information about a specific authorized OAuth application. Returns the app's ID, name, description, and list of users who have linked their Mailchimp accounts to this application. Use LIST_AUTHORIZED_APPS first to get valid app_id values.

Get information about a specific subscriber in a classic automation email queue. This action retrieves details about a subscriber who is waiting to receive an automated email, including their email address and the scheduled send time. Note: Subscribers appear in the queue when they've been triggered by the automation but haven't yet received the email. The queue is typically processed quickly, so subscribers may only be in the queue briefly. Returns HTTP 404 if the subscriber is not found in the queue.

Retrieve details of a Mailchimp automation workflow by its ID. Returns comprehensive information including: - Basic info: ID, status (save/paused/sending/archived), creation time - Settings: title, from_name, reply_to email - Recipients: associated list/audience ID, store ID for e-commerce automations - Tracking: opens, clicks, e-commerce tracking configuration - Report summary: opens, clicks, rates (for archived automations) Use MAILCHIMP_LIST_AUTOMATIONS to get available workflow IDs.

Get the status of a batch operation. Retrieves details about a specific batch operation including its current status (pending, preprocessing, started, finalizing, or finished), operation counts, timestamps, and a URL to download the results when completed.

Retrieve detailed information about a specific batch webhook by its ID. Batch webhooks are used to receive notifications when batch operations complete. Use this endpoint to check the configuration and status of a specific webhook.

Get detailed information about a specific abuse report for a campaign. An abuse complaint occurs when your recipient reports an email as spam in their mail program. This action retrieves the details of a specific abuse report including the email address that filed the complaint, the date of the report, and associated list information. Prerequisites: - You need a valid campaign_id (use 'list_campaigns' to find one) - You need a valid report_id (use 'retrieve_campaign_abuse_complaints' to list abuse reports)

Get the HTML and plain-text content for a campaign.

Get a specific feedback message from a campaign.

Get information about a specific folder used to organize campaigns in Mailchimp. Returns the folder details including its ID, name, and the count of campaigns stored within it. Use the 'list_campaign_folders' action to get available folder IDs.

Get click details for a specific link in a campaign. This endpoint retrieves detailed click statistics for a single link within a sent campaign, including total clicks, unique clicks, click percentages, and the timestamp of the last click. Use list_campaign_details first to get the list of available link IDs for a campaign.

Get information about a specific campaign recipient.

Retrieve detailed performance report for a Mailchimp campaign. Returns analytics including email delivery stats (sent, bounced), engagement metrics (opens, clicks), and e-commerce data (orders, revenue). Works for both sent campaigns (with actual data) and draft campaigns (returns zeros).

Review the send checklist for a Mailchimp campaign before sending. Returns a list of checklist items indicating issues that need to be resolved. Each item has a 'type' field: 'error' (must fix before sending), 'warning' (optional but recommended to address), or 'success' (item is complete). The 'is_ready' field indicates if the campaign can be sent (True when no errors). Common checklist items include: audience selection, subject line, from name/email, email content, and tracking settings.

Retrieve detailed information about a specific cart in an e-commerce store, including customer details and line items.

Retrieve detailed information about a specific line item in a shopping cart. Returns product details, variant information, quantity, and price for a single cart line item. Useful for displaying cart item details or verifying cart contents before checkout.

Get detailed information about a specific subscriber who clicked a link in a campaign. This action retrieves click data for a specific list member who clicked on a particular tracked link in a sent campaign. Use this to understand individual subscriber engagement with campaign links. Prerequisites: - The campaign must have been sent (status: 'sent') - The link must be a tracked link in the campaign - The subscriber must have clicked the link at least once To get the required IDs: 1. campaign_id: Use list_campaigns with status='sent' 2. link_id: Use list_campaign_details with the campaign_id to get urls_clicked 3. subscriber_hash: Use list_clicked_link_subscribers to get email_id of clickers

Retrieve information about a specific connected site in your Mailchimp account. Connected sites allow Mailchimp to track website activity and visitor behavior for your email marketing campaigns. Use this action to get details about a site including its domain, platform type, and the JavaScript tracking snippet. Returns the site's foreign_id, domain, platform, tracking script (site_script), and creation/update timestamps.

API endpoint for Conversations is deprecated, replaced by Inbox. Although historical data is accessible, new campaign replies and messages are not retrievable through this endpoint.

Get information about a specific customer.

Get the details for a single verified domain on the Mailchimp account. Retrieves information about a specific domain including its verification status, authentication status, and the email address used for verification. Use this action to check if a domain has been verified and is ready for sending emails. Returns 404 if the domain is not found in the account's verified domains list.

Retrieve detailed information about a specific Facebook ad created through Mailchimp. Returns ad details including id, name, web_id, channel_id (e.g., 'fb'), type, status (e.g., 'paused', 'active', 'disconnected'), audience targeting information, budget settings, content, create_time, start_time, end_time, and feedback data. Note: Facebook ads must be created through Mailchimp's Facebook Ad Campaigns feature. To get the outreach_id, first use the list_facebook_ads action to retrieve available ads.

Retrieve detailed performance report for a specific Facebook ad campaign. Returns comprehensive metrics including impressions, clicks, reach, engagement, budget information, content details, and ecommerce performance data. The report provides insights into ad effectiveness and ROI. Note: Requires a valid outreach_id which can be obtained from the list_facebook_ads or list_facebook_ads_reports endpoints.

Retrieve detailed information about a specific file in the Mailchimp File Manager. Returns file metadata including the file's unique ID, name, type, size, URLs for accessing the file (full-size and thumbnail), upload timestamp, and dimensions for image files. Use this action to get the public URL of a file for use in campaigns or to verify file details. Prerequisites: - You need a valid file_id. Use MAILCHIMP_LIST_STORED_FILES to get available file IDs. Returns: - File metadata including id, name, type, size, URLs, and dimensions (for images) - HATEOAS links for related operations (update, delete) Common use cases: - Get the public URL of an uploaded image for use in email campaigns - Verify file upload succeeded and get file details - Check file dimensions before using in templates

Get information about a specific folder in the File Manager.

Retrieves detailed growth statistics for a Mailchimp audience/list for a specific month. Returns subscriber metrics including existing members, new opt-ins, imports, unsubscribes, cleaned (bounced), pending, deleted, and transactional members. The month parameter must be in YYYY-MM format. Note: Returns 404 if no growth history data exists for the specified month - use 'List growth history data' action first to check available months.

Get information about all available surveys for a specific list.

Get detailed information about a specific interest category within a Mailchimp list/audience. Interest categories are groups of interests (preferences) that subscribers can select on signup forms. The type field determines how interests are displayed: checkboxes (multi-select), dropdown (single-select), radio (single-select), or hidden (internal tracking only).

Retrieve details of a specific interest (group) within an interest category for a Mailchimp list.

Get the HTML content for a specific Mailchimp landing page by its unique page ID.

Retrieve detailed information about a specific Mailchimp landing page including its name, title, status, tracking settings, and associated list.

Get analytics report for a specific landing page. Returns detailed statistics including total visits, clicks, and time-series data (daily and weekly). For e-commerce enabled pages, also includes revenue and order data. Use the list_landing_pages action to get available landing page IDs.

Return the Chimp Chatter for this account ordered by most recent.

Get information about a specific list in your Mailchimp account. Results include list members who have signed up but haven't confirmed their subscription yet and unsubscribed or cleaned.

Get information about a specific list member, including a currently subscribed, unsubscribed, or bounced member.

Retrieve a specific note attached to a list member in Mailchimp. Notes are internal annotations that can be added to subscriber records for tracking conversations, preferences, or other relevant information. This endpoint returns the full details of a single note by its ID.

Retrieve details about a specific merge field (custom audience field) for a Mailchimp list. Merge fields are custom data fields like First Name (FNAME), Last Name (LNAME), Address, etc. that store subscriber information. Use this to get configuration details including field type, display settings, and type-specific options.

The conversation endpoint is outdated and replaced by Inbox, which isn't supported by it. Historical conversation data is accessible, but new replies and Inbox messages are not.

Get information about a specific subscriber who opened a campaign.

Get information about a specific order.

Get information about a specific order line item.

Retrieve detailed information about a specific product image in a Mailchimp e-commerce store. Returns the image's URL, associated variant IDs, and API links for related operations. Requires valid store_id, product_id, and image_id. Returns 404 if any ID is not found.

Get information about a specific product.

Retrieve detailed information about a specific product variant from a Mailchimp e-commerce store. Returns variant details including title, SKU, price, inventory quantity, and URLs. Requires valid store_id, product_id, and variant_id. Use LIST_STORES, LIST_PRODUCT, and LIST_PRODUCT_VARIANTS to find the required identifiers.

Retrieve detailed information about a specific promo code. Returns the promo code details including its code string, redemption URL, usage count, enabled status, and timestamps. Promo codes are associated with promo rules within e-commerce stores.

Get information about a specific promo rule.

Get information about a specific segment.

Get information about a specific store.

Get a specific list member's email activity in a sent campaign, including opens, clicks, bounces, and unsubscribes. The campaign must have been sent and the subscriber must have been a recipient for data to be available. Returns 404 if the campaign hasn't been sent or if the subscriber wasn't a recipient.

Get information about a specific subscriber who was removed from a classic automation workflow. Returns the subscriber's email address and workflow details. The subscriber must have been previously removed using the remove_subscriber_from_workflow action. Returns 404 if the subscriber is not found in the removed subscribers list.

Retrieves detailed information about a specific survey associated with a Mailchimp audience (list). Returns survey metadata including its title, status, URL, timestamps, total response count, and the list of questions. Prerequisites: The survey must exist on the specified list. Surveys are created through the Mailchimp web interface, not via the API. Use 'Get information about all surveys for a list' to find available survey IDs for a given audience.

Retrieves detailed reporting data for a specific question in a survey. Returns the question text, type, total response count, and for multiple choice questions, the breakdown of responses per option including counts. For rating questions, includes the average rating. Prerequisites: The survey and question must exist in your Mailchimp account. Surveys are created through the Mailchimp web interface, not via the API. Use 'List survey reports' to find survey IDs and 'List survey question reports' to find question IDs. Note: This action returns aggregated statistics for a single question. For detailed individual answers to a question, use 'List answers for question'. For the overall survey report, use 'Get survey report'.

Retrieves detailed reporting data for a specific survey. Returns survey metadata including its title, status, public URL, creation/publication timestamps, total response count, and the associated audience information. Prerequisites: The survey must exist in your Mailchimp account. Surveys are created through the Mailchimp web interface, not via the API. Use 'List survey reports' to find available survey IDs for surveys that have report data. Note: This action returns report-level summary data. For detailed question-level reports, use 'List survey question reports'. For individual response data, use 'List survey responses'.

Retrieve a single survey response by its ID. Returns detailed information about the respondent's answers to all questions in the survey. This endpoint is useful for examining individual responses in detail, including the respondent's contact information and all their answers. Prerequisites: You must have an existing survey with at least one response. Surveys are created through the Mailchimp web interface and cannot be created via API.

Retrieve information about a specific template folder in Mailchimp. Template folders are used to organize email templates. This action returns the folder's name, unique ID, the count of templates it contains, and HATEOAS links for related operations (update, delete, list templates). Use this action when you need to: - Get details about a specific template folder - Check how many templates are in a folder - Retrieve links to related operations for the folder

Get information about a specific template.

Get detailed information about a specific list member who unsubscribed from a campaign. This endpoint retrieves unsubscribe details for a member identified by their subscriber hash (MD5 of lowercase email) from a specific campaign's report. The campaign must have been sent and the member must have unsubscribed from it. Use the List Unsubscribed Members endpoint first to find valid subscriber hashes for a campaign. Returns 404 if the subscriber hash is not found in the campaign's unsubscribe list.

Get information about a specific webhook for a Mailchimp list (audience). Returns the webhook's URL, enabled events (subscribe, unsubscribe, profile, cleaned, upemail, campaign), and trigger sources (user, admin, api).

Get information about an individual classic automation workflow email.

Get all abuse reports for a specific list.

Get a list of account exports for a given account.

Get information about an account's orders.

Retrieves all answers submitted for a specific question in a Mailchimp survey. This endpoint is part of the Reporting API and provides detailed response data for survey analysis. Use this to analyze how respondents answered a particular question, including their contact information and submission timestamps. Prerequisites: - The survey must exist and have been published to collect responses - Surveys are created through the Mailchimp web interface, not via API - Use 'List survey reports' to find available survey IDs - Use 'List survey question reports' to find question IDs for a specific survey Returns a list of answers with respondent details and the answer values.

Get a list of an account's registered, connected applications.

Get information about a classic automation email queue.

Get a summary of the emails in a classic automation workflow.

Get a summary of an account's classic automations.

Get a summary of batch requests that have been made.

Get all webhooks that have been configured for batches.

Get team feedback while you're working together on a Mailchimp campaign.

Get all folders used to organize campaigns.

Get detailed information about any campaign emails that were opened by a list member.

Get breakdown of product activity for a campaign

Get information about campaign recipients.

Retrieve analytics reports for sent email campaigns. Returns performance metrics including opens, clicks, bounces, unsubscribes, and e-commerce data for campaigns that have been sent.

Retrieve all line items in a shopping cart. Returns a list of products/variants that have been added to a specific cart in an e-commerce store. Each line item includes product details, variant info, quantity, and price. Useful for abandoned cart workflows and order management.

Get information about a store's carts.

Get a list of child campaign reports for a specific parent campaign. This endpoint returns reports for child campaigns that are part of A/B split test (variate) or RSS campaigns. For regular campaigns, this will return an empty reports array with total_items=0 since they do not have child campaigns.

Get information about list members who clicked on a specific link in a campaign. This action retrieves all subscribers who clicked on a particular tracked link within a sent campaign, including click counts and subscriber details. Prerequisites: 1. The campaign must have been sent (status='sent') with click tracking enabled 2. The link must exist in the campaign and have been clicked at least once To get the required IDs: 1. campaign_id: Use list_campaigns with status='sent' to find sent campaigns 2. link_id: Use list_campaign_details with the campaign_id to get urls_clicked array Returns empty members array if no subscribers clicked the link.

Get all connected sites in an account.

List of conversations for an account is available via an endpoint, but it's deprecated in favor of Inbox. The endpoint excludes new Inbox data including campaign replies and messages. Past conversations remain accessible.

Get information about a store's customers.

Get statistics for the top-performing email domains in a campaign.

Get EepURL click activity for a campaign. EepURL is Mailchimp's shareable campaign archive link used for social media sharing. Returns referrer information including IP addresses/domains that clicked the link, click counts, and timestamps.

Get a list of member's subscriber activity in a specific campaign.

Get list of Facebook ads.

Get reports of Facebook ads.

Get breakdown of product activity for a Facebook ad outreach. Returns a paginated list of products with ecommerce activity metrics attributed to a specific Facebook ad campaign. Includes revenue, purchase counts, and recommendation data for each product. Note: Requires a valid outreach_id which can be obtained from the list_facebook_ads or list_facebook_ads_reports endpoints. The Facebook ad must have ecommerce tracking enabled with a connected store.

Get a list of all folders in the File Manager.

Get a month-by-month summary of a specific list's growth activity.

Get information about a list's interest categories.

Get a list of this category's interests.

Get all landing pages.

Get performance reports for landing pages. Returns analytics data including visits, unique visits, clicks, subscribes, and conversion rates for published landing pages. Only landing pages that have been published will appear in reports.

Get the locations (countries) that the list's subscribers have been tagged to based on geocoding their IP address.

Get events for a contact.

Get the last 50 Goal events for a member on a specific list.

Get the tags on a list member.

Get information about members in a saved segment.

Get information about members in a specific Mailchimp list.

Get a list of all merge fields for an audience.

List all messages from a specific conversation in Mailchimp. NOTE: The Conversations API is deprecated and replaced by Inbox. This endpoint only returns historical conversation data. New campaign replies and Inbox messages are NOT available through this endpoint. Use 'List Conversations' first to obtain valid conversation IDs.

Get information about an order's line items.

Get information about a store's orders.

Get information about a store's products.

Get information about a product's images.

List all variants for a specific product in a Mailchimp e-commerce store. Returns a paginated list of product variants including details like title, SKU, price, inventory quantity, and URLs. Use 'count' and 'offset' parameters to paginate through large variant lists. Requires valid store_id and product_id. Use LIST_STORES and LIST_PRODUCT to find the required identifiers.

Get information about a store's promo codes.

Get information about a store's promo rules.

Get recent notes for a specific list member.

Get information about all available segments for a specific list.

Get all of the sending domains on the account.

Get signup forms for a specific list.

Get a list of available images and files stored in the File Manager for the account.

Get information about all stores in the account.

Get information about subscribers who were removed from a classic automation workflow.

Get reports for all questions in a specific survey. Returns detailed reporting data for each question in the survey, including response counts, answer distributions for choice questions, and average ratings for range questions. This action is useful for analyzing survey results and understanding how respondents answered each question. Prerequisites: - A survey must exist in your Mailchimp account (surveys are created in the web interface) - Use 'List survey reports' or 'Get information about all surveys for a list' to find survey IDs Returns 404 error if the survey_id does not exist.

Get reports for surveys.

Retrieve all responses submitted to a survey. Returns a list of responses including respondent contact information, submission timestamps, and all question/answer results for each response. This endpoint is useful for analyzing survey results programmatically, exporting response data, or building integrations that react to survey submissions. Prerequisites: You must have an existing survey with at least one response. Surveys are created through the Mailchimp web interface and cannot be created via API. Use the 'List survey reports' or 'Get information about all surveys for a list' actions to find available survey IDs.

Retrieve all template folders from the Mailchimp account. Template folders are used to organize email templates. This action returns a paginated list of all folders with their IDs, names, and template counts. Use the count and offset parameters to paginate through large result sets.

Get a list of an account's available templates.

Get the top email clients used by subscribers in a Mailchimp list/audience. Returns statistics about the email clients (e.g., Gmail, Apple Mail, Outlook) used by subscribers, including the number of members using each client and the percentage of the total list. This data is collected via open tracking and relies on image loading, so contacts who disable images will not be tracked.

Get top open locations for a specific campaign. Returns geographic data about where subscribers opened a campaign email, based on geocoding their IP addresses. Results include country codes, regions, and open counts for each location.

Get information about members who have unsubscribed from a specific campaign.

Get information about all webhooks for a specific list.

A health check for the API that won't return any account-specific information.

Get a list of abuse complaints for a specific campaign.

Get a list of available images and files stored in this folder.

Search all campaigns for the specified query terms. This action searches across campaign titles, subject lines, and content to find campaigns matching the provided query. Returns detailed campaign information including settings, tracking configuration, recipients, and status. Use the 'fields' parameter to limit response data or 'exclude_fields' to remove unnecessary fields like '_links' for cleaner responses.

Search for tags on a list by name. If no name is provided, will return all tags on the list.

Verify that the Mailchimp connected site tracking script has been installed on the website. This checks if the script is properly installed either via the script URL or HTML fragment. Use this to confirm a connected site's tracking integration is working correctly. Returns HTTP 204 on success (script is installed) or HTTP 404 if the site is not found.

Get the sections that you can edit in a template, including each section's default content.

Get a member's activity on a specific list, including opens, clicks, and unsubscribes.

Get the last 50 events of a member's activity on a specific list, including opens, clicks, and unsubscribes.

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).

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.

Create a new interest category.

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

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).

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).

Add a new note for a specific subscriber in a Mailchimp list (audience). Notes are useful for keeping internal records about contacts, such as conversation history, preferences, or other relevant information.

Add a new merge field for a specific audience.

Add a new line item to an existing order in a Mailchimp e-commerce store. Prerequisites: The store, order, product, and product variant must already exist. Use MAILCHIMP_ADD_STORE, MAILCHIMP_ADD_ORDER, and MAILCHIMP_ADD_PRODUCT to create them first if needed.

Add a new product to a Mailchimp e-commerce store. Products are e-commerce items that can be added to carts and orders. Each product requires at least one variant. Products must be created before they can be included in carts or orders. For product recommendations to work properly, ensure products have a valid image_url and variants have inventory_quantity > 0.

Add a new image to a product in a Mailchimp e-commerce store. The image must be hosted at a publicly accessible URL. You can optionally associate the image with specific product variants.

Add a new promo code to an e-commerce store under an existing promo rule. A promo code contains the actual discount code that customers can apply at checkout, along with a redemption URL. You must first create a promo rule (which defines the discount type, amount, and target) before you can add promo codes to it.

Add a new promo rule to a store. Promo rules define the parameters for promotional discounts such as percentage off, fixed amount off, or free shipping. After creating a promo rule, you can create promo codes under it using the Add Promo Code endpoint.

Create a new segment in a specific Mailchimp list/audience. Segments can be either static (based on a list of specific email addresses) or saved (based on matching conditions). For static segments, provide static_segment with email addresses. For saved segments, provide options_match and options_conditions to define the segment criteria. Note: static_segment and options fields are mutually exclusive - use one or the other.

Add a new store to your Mailchimp account.

Manually add a subscriber to a classic automation workflow email queue, bypassing the default trigger settings. This action allows you to: - Add a list member to a specific automation email's queue - Trigger a series of automated emails in an API 3.0 workflow type - Bypass the normal trigger conditions for an automation Note: The subscriber must be a member of the list associated with the automation workflow. Returns HTTP 204 No Content on success.

Create a new email template in the Mailchimp account. Templates can be used to create consistent email campaigns. Only Classic (HTML) templates are supported through this API endpoint. The template HTML can include Mailchimp merge tags (e.g., *|FNAME|*) for personalization.

Create a new template folder in Mailchimp. Template folders help organize your email templates. Use this action to create a new folder, then add templates to it using the folder's ID.

Create a new webhook for a specific Mailchimp audience/list. Creates a webhook that will receive POST notifications when specified events occur. The webhook URL must be accessible and return HTTP 200 to validation requests. Requires a Standard or Premium Mailchimp plan for webhook functionality.

Create a new email campaign that links to a specific survey in Mailchimp. This action generates a campaign based on an existing survey for a given audience/list. The survey must already exist in Mailchimp before creating a campaign for it. The created campaign will include a link to the survey, allowing recipients to participate. Prerequisites: - A valid Mailchimp audience/list (use 'Get lists info' to retrieve available lists) - An existing survey for that list (use 'Get information about all surveys for a list' to retrieve surveys) Returns the created campaign details including campaign ID, status, recipients, and settings.

Replicate a campaign in saved or send status.

Resend a previously sent campaign to specific subscriber segments. This creates a replica of the original campaign and sends it to common segments such as those who didn't open the original campaign, didn't click any links, or new subscribers added since the campaign was sent. IMPORTANT: The original campaign must: - Have been previously sent (status='sent') - Have tracking enabled (opens/clicks tracking) - Be eligible for resending (check the 'resendable' field on the campaign)

Begin processing a batch operations request.

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.

Pause all emails in a specific classic automation workflow. This action pauses all emails in a classic automation workflow. The automation must be in 'sending' status to be paused. If the automation is already paused or in draft/save status, the API will return an error. Use cases: - Temporarily stop an automation workflow from sending emails - Pause automation for maintenance or content updates - Stop emails during a campaign review period Note: To resume a paused automation, use the start_automation_emails action.

Pause an RSS-Driven campaign that is currently sending. This action pauses an active RSS campaign, stopping it from sending new emails based on its schedule until it is resumed. Only campaigns of type 'rss' that are currently in 'sending' status can be paused. Prerequisites: - The campaign must be of type 'rss' (not 'regular', 'plaintext', etc.) - The campaign must be in 'sending' status (actively running according to schedule) - Campaigns in 'save', 'paused', or 'sent' status cannot be paused Use RESUME_RSS_CAMPAIGN to resume a paused RSS campaign. Use LIST_CAMPAIGNS with type='rss' to find RSS campaigns.

Publishes a survey that is in draft, unpublished, or has been previously published and edited. Once published, the survey becomes accessible via its public URL and can collect responses from your audience. Prerequisites: The survey must exist on the specified list and must be created through the Mailchimp web interface (surveys cannot be created via the API). The survey must be in 'draft' or 'unpublished' status. Use 'Get information about all surveys for a list' to find available surveys and their current status.

Publish a Mailchimp landing page to make it live and accessible to visitors. Publishes a landing page that is currently in 'draft', 'unpublished', or has been previously published and edited. Once published, the landing page will be accessible via its public URL. Requirements: - The landing page must exist and be in a publishable state (draft or unpublished) - The Mailchimp account must have sending permissions enabled - The landing page should have valid content configured Note: Returns HTTP 204 No Content on successful publish with an empty response body.

Resume an RSS-Driven campaign that was previously paused. This action restarts the RSS feed delivery schedule for a paused RSS campaign. The campaign will continue checking the RSS feed and sending emails according to its configured schedule. Prerequisites: - Campaign must be of type 'rss' - Campaign must be in 'paused' status (was previously running and then paused) - Use PAUSE_RSS_CAMPAIGN to pause a running RSS campaign first - Use LIST_CAMPAIGNS with type='rss' and status='paused' to find eligible campaigns On success, returns HTTP 204 No Content. The campaign status will change from 'paused' back to 'sending'.

Schedule a campaign for delivery at a specific date and time. Important notes: - The campaign must be in 'save' (draft) status and pass all send checklist items - Schedule time must be in the future and on the quarter-hour (:00, :15, :30, :45) - If using Multivariate Campaigns to test send times or RSS Campaigns, use the send action instead - Timewarp and Batch Delivery cannot be used together - Requires a paid Mailchimp plan to schedule campaigns (free plans cannot schedule)

Send a test email for a campaign to preview it before sending to your audience. This action allows you to send a test version of your campaign to specified email addresses to verify the content, formatting, and personalization before the final send. The campaign must have content set before a test email can be sent.

Set the content for a campaign.

Start a specific automated email within an Automation workflow. This action starts sending a specific automated email that is part of a classic automation workflow. The email must be in a 'paused' status to be started. Emails in 'save' (draft) status may need additional configuration in the Mailchimp web interface before they can be started. Prerequisites: - The automation workflow must exist and not be archived - The automated email must be properly configured (subject line, content, etc.) - The email should be in 'paused' status (use Pause Automated Email first if needed) Common error responses: - 400: The automation email is missing requirements and can't be started - 404: The workflow_id or workflow_email_id was not found

Start all emails in a classic automation workflow. This action starts all emails in a specific classic automation workflow. Once started, the automation will begin sending emails to subscribers based on its configured triggers. Prerequisites: - The automation must be in 'save' status (not 'archived') - The automation must be properly configured with email content - For abandoned cart automations, additional setup may be required in the UI Returns HTTP 204 No Content on success.

Unpublishes a survey that is currently published, making it unavailable for responses. The survey must be in 'published' status before calling this action. Prerequisites: The survey must exist on the specified list and be currently published. Surveys are created through the Mailchimp web interface, not via the API. Use 'Get information about all surveys for a list' to find available survey IDs, and 'Get survey' to verify a survey's current status before unpublishing. Returns the updated survey details with status changed to 'unpublished'.

Unpublish a Mailchimp landing page. Takes a published landing page offline, changing its status back to draft. The page URL will no longer be accessible to visitors after unpublishing. This action can also be called on pages that are already in draft status (it will succeed without error). To publish a landing page, use the publish_landing_page action.

Unschedule a scheduled campaign that hasn't started sending. The campaign must be in 'schedule' status (not 'save', 'sent', or 'sending'). After unscheduling, the campaign status reverts to 'save' and can be edited or rescheduled. Returns HTTP 204 No Content on success.

Update a webhook that will fire whenever any batch request completes processing.

Update a specific feedback message for a campaign.

Update the name of a campaign folder in Mailchimp. Campaign folders help organize email marketing campaigns into logical groups. Use this action to rename an existing folder. Returns the updated folder details including the folder ID, new name, and the count of campaigns in the folder.

Update some or all of the settings for a specific campaign.

Update a specific cart.

Update a specific cart line item in a Mailchimp e-commerce store. Use this action to modify the quantity, price, or product association of an existing line item in a shopping cart. All update fields are optional - only provide the fields you want to change. Carts and their line items are typically used for abandoned cart automations.

Update an e-commerce customer's information in a Mailchimp store. Updates customer details such as name, company, opt-in status, and address. Note: The store must be associated with a Mailchimp list (audience) for this operation to succeed.

Update an existing file's name or folder in the Mailchimp File Manager. This action allows you to rename a file or move it to a different folder. You can update the name, folder, or both in a single request. At least one of 'name' or 'folder_id' should be provided to make a meaningful update. To move a file to the root folder, set folder_id to 0. The file's content and URLs remain unchanged; only the metadata is updated. Returns the updated file's details including its ID, name, folder, URLs, and metadata.

Update the name of a File Manager folder in Mailchimp. Use this action to rename an existing folder in the Mailchimp File Manager. File Manager folders help organize images and other files used in campaigns, templates, and other Mailchimp content. Note: Only the folder name can be updated. The folder ID and creation metadata remain unchanged.

Update a specific interest category.

Update an interest (group name) within an interest category on a Mailchimp list. Use this action to modify the name or display order of an existing interest. Interests are used to segment subscribers based on their preferences. The 'name' parameter is required for this update operation.

Update a landing page.

Update information for a specific list member.

Update settings for a Mailchimp audience (list). This PATCH endpoint supports partial updates - only include the fields you want to change. The list_id is required to identify which audience to update. All other fields are optional. To update contact information, use the contact__* fields (e.g., contact__company, contact__city). To update campaign defaults, use the campaign__defaults__* fields (e.g., campaign__defaults__from__name).

Update a specific segment in a list. Use when you need to modify segment name, conditions, or static members.

Update a specific merge field (audience field) for a Mailchimp list. Use this action to modify properties of an existing merge field such as its name, whether it's required, default value, display order, help text, and type-specific options. Only provide the fields you want to change.

Update a specific note for a specific list member.

Update a specific order line item.

Update a specific product.

Update a product image in a Mailchimp e-commerce store. Use this action to modify an existing product image's URL or associate it with specific product variants. Requires valid store_id, product_id, and image_id. At least one of 'url' or 'variant_ids' must be provided in the request body.

Update a product variant.

Update a promo code.

Update an existing promo rule for an e-commerce store. Promo rules define discount promotions that can be applied to orders, items, or shipping. Only the fields provided will be updated.

Update a store.

Update the name, HTML, or `folder_id` of an existing template.

Update the name of an existing template folder in Mailchimp. Template folders help organize email templates for easier management. Use this action to rename a folder. The folder_id can be obtained from the add_template_folder or list_template_folders actions. Returns the updated folder information including the new name, folder ID, and the count of templates contained in the folder.

Update the settings for an existing webhook in a Mailchimp list (audience). This action allows you to modify the URL, event triggers, and source triggers of a webhook. Only the settings you provide will be updated; other settings will remain unchanged.

Update settings for a classic automation workflow email. Only works with workflows of type: abandonedBrowse, abandonedCart, emailFollowup, or singleWelcome.

Add or update an e-commerce order in a Mailchimp store. Uses PUT semantics - if the order exists it will be updated, otherwise a new order will be created. The order_id in the path and the id in the request body should match.

Create or update a product in a Mailchimp e-commerce store. Use when you need to add a new product or update an existing product with idempotent behavior. This endpoint uses PUT semantics - if the product exists, it will be updated; if not, a new product will be created.

Complete domain verification by submitting the verification code. This action completes the domain verification process started by 'add_domain_to_account'. When a domain is added, a verification email is sent to the specified email address containing a unique verification code. Use this action to submit that code and complete the verification. Once verified, the domain can be used as a sender address in campaigns. Prerequisites: - Domain must be added first using 'add_domain_to_account' - Domain status should be 'VERIFICATION_IN_PROGRESS' - You need the verification code from the email sent during domain addition Common errors: - 400: Invalid verification code - the code doesn't match or has expired - 404: Domain not found - the domain hasn't been added to the account

Delete a specific campaign folder from Mailchimp. When a campaign folder is deleted, all campaigns within that folder are automatically marked as 'unfiled' rather than being deleted. This operation is idempotent - deleting an already-deleted folder will return an error indicating the folder was not found. Returns HTTP 204 No Content on success.

Delete a cart from an e-commerce store. This endpoint permanently removes a cart and all its line items from the specified store. Use this when a cart is no longer needed (e.g., after converting it to an order or when the customer has abandoned the checkout process). Note: Deleting a cart will cancel any pending abandoned cart automation emails associated with it. Carts do not automatically expire and will remain until deleted.

Delete a specific line item from a cart in a Mailchimp e-commerce store. Cart line items represent products that a customer has added to their shopping cart. This action permanently removes a line item from the specified cart. The deletion cannot be undone - to restore the item, you would need to add it again using 'add_cart_line_item'. Use this action when: - A customer removes an item from their cart - You need to clear invalid or outdated line items - Syncing cart changes from your e-commerce platform to Mailchimp Note: If you need to delete the entire cart, use 'delete_cart' instead.

Remove a connected site from your Mailchimp account. This action permanently deletes the specified connected site. Connected sites are external websites that have been linked to your Mailchimp account for tracking and integration purposes. Once deleted, the site tracking script will no longer collect data for this site. Note: This action is idempotent - deleting an already-deleted site will not cause an error but may return a 404 Not Found response.

Delete a customer from an e-commerce store. Permanently removes a customer record from the specified Mailchimp store. This action is destructive and cannot be undone. The customer's associated data including order history linkage will be removed, but existing orders will not be deleted. Returns HTTP 204 No Content on successful deletion.

Delete a sending domain from the Mailchimp account's verified domains. This permanently removes a domain that was previously added for verification. The domain can be in any verification state (pending, verified, or authenticated). After deletion, the domain will no longer appear in the verified-domains list and cannot be used as a sender address until re-added and re-verified. Use 'list_sending_domains' to see available domains before deletion.

Permanently remove a file from the Mailchimp File Manager. This action deletes an image or document file from your Mailchimp account's File Manager. Once deleted, the file cannot be recovered. Files in the File Manager are typically used in campaigns, templates, or signup forms. IMPORTANT: This is a destructive action. Ensure you have the correct file_id before executing, as deletion is permanent. Files that are actively used in campaigns may still be accessible until those campaigns are deleted.

Delete a specific folder in the File Manager. This permanently removes the folder and all files contained within it. Use with caution as this action cannot be undone.

Delete a specific interest category from a Mailchimp audience/list. Interest categories are used to group related interests together on signup forms (e.g., 'Newsletter Preferences', 'Product Interests'). Each category can contain multiple interests that subscribers can select. WARNING: This action permanently deletes the interest category and all interests within it. This cannot be undone. Any subscriber data associated with these interests will also be removed. Use this action when you need to: - Remove obsolete or unused interest categories - Clean up test data - Reorganize your list's interest structure Prerequisites: - Obtain the list_id using 'Get lists info' action - Obtain the interest_category_id using 'List interest categories' action

Delete a specific interest (group name) from an interest category within a Mailchimp list. This permanently removes the interest from the category. Returns HTTP 204 on success.

Permanently delete a Mailchimp landing page. This action permanently removes a landing page from your Mailchimp account. This operation cannot be undone. The landing page must exist and be in a deletable state (draft or unpublished). Published landing pages should be unpublished first before deletion. Returns a 204 No Content response on success, indicating the page was deleted. Returns a 404 error if the page_id does not exist.

Permanently delete a list (audience) from your Mailchimp account. WARNING: This is a destructive and irreversible operation. Deleting a list will permanently remove all associated data including: - Subscriber email addresses and profile data - Subscriber activity history (opens, clicks, etc.) - Unsubscribe records - Complaint records - Bounce records - Segments and tags Export and backup your list data before deletion if needed. Returns HTTP 204 No Content on success.

Permanently delete a list member and all their personally identifiable information (PII). WARNING: This is an irreversible action. Once deleted, the member cannot be re-imported with the same email address. Use this for GDPR compliance or when permanently removing a contact. For soft removal (keeping the ability to re-add later), use archive_list_member instead. Returns HTTP 204 No Content on success with an empty response body.

Delete a specific merge field (audience field) from a Mailchimp list/audience. WARNING: This action permanently deletes the merge field and all associated data collected from that field. This cannot be undone. Consider hiding the field from signup forms instead of deleting it. Back up your audience data before deleting. Note: Default merge fields (FNAME, LNAME, ADDRESS, PHONE) cannot be deleted.

Delete a specific note for a list member in Mailchimp. Permanently removes a note associated with a subscriber. This operation cannot be undone. A successful deletion returns HTTP 204 No Content. To delete a note, you need: - list_id: The unique ID of the Mailchimp audience/list - subscriber_hash: The member's email address, MD5 hash of lowercase email, or contact_id - note_id: The unique ID of the note (can be obtained from list_recent_member_notes)

Permanently delete an order from a Mailchimp e-commerce store. This action removes the order and its associated line items. This operation cannot be undone.

Delete a specific line item from an order in a Mailchimp e-commerce store. This action permanently removes the specified line item from the order. The operation is idempotent - deleting an already-deleted line item returns the same success response. Prerequisites: The store, order, and line item must exist. Use MAILCHIMP_LIST_STORES, MAILCHIMP_LIST_ORDERS, and MAILCHIMP_LIST_ORDER_LINE_ITEMS to find valid IDs. Note: This action cannot be undone. To add the line item back, use MAILCHIMP_ADD_ORDER_LINE_ITEM.

Permanently delete a product from a Mailchimp e-commerce store. This action removes the product and all its variants. Returns HTTP 204 on success with no content. Use LIST_STORES to find store IDs and LIST_PRODUCT to find product IDs. This operation cannot be undone.

Delete a product image from a Mailchimp e-commerce store. This action permanently removes an image associated with a product. The operation is idempotent - deleting an already-deleted image will not cause an error. Before deleting, ensure you have the correct store_id, product_id, and image_id as this action cannot be undone.

Delete a specific product variant from a Mailchimp e-commerce store. This action permanently removes a variant from a product. Use this to clean up discontinued variants or manage product options. Note that a product must always have at least one variant, so attempting to delete the last remaining variant of a product will fail. Prerequisites: - The store must exist (use list_stores to verify) - The product must exist in the store (use list_product to verify) - The variant must exist and not be the only variant for the product

Delete a promo code from an e-commerce store. This action permanently removes a specific promo code from a promo rule in a Mailchimp store. The promo code will no longer be available for customers to use. This action is idempotent - deleting an already-deleted promo code will not cause an error. Prerequisites: - The store must exist (use MAILCHIMP_LIST_STORES to verify) - The promo rule must exist in the store (use MAILCHIMP_LIST_PROMO_RULES to verify) - The promo code must exist within the promo rule (use MAILCHIMP_LIST_PROMO_CODES to verify) Note: This action is destructive and cannot be undone. The promo code will need to be recreated using MAILCHIMP_ADD_PROMO_CODE if you want to restore it.

Permanently delete a promo rule from a Mailchimp e-commerce store. This action also removes all associated promo codes. Warning: This operation is irreversible. Returns HTTP 204 on success with no content body.

Permanently delete a segment from a Mailchimp list (audience). This action removes the segment definition from the list. It does NOT delete the contacts/members within the segment - they remain in the list. Both static segments and saved segments can be deleted using this action. Note: This is a destructive operation that cannot be undone. Use with caution.

Delete an e-commerce store from your Mailchimp account. WARNING: This is a destructive operation. Deleting a store will permanently remove all associated subresources, including Customers, Orders, Products, and Carts. This action cannot be undone. Returns HTTP 204 No Content on successful deletion.

Permanently delete a user-created email template from your Mailchimp account. This action removes the specified template and cannot be undone. Only templates of type 'user' (custom templates you created) can be deleted. System templates and gallery templates cannot be deleted. Returns HTTP 204 No Content on success. Returns HTTP 404 if the template does not exist or is not a user template.

Permanently delete a template folder from your Mailchimp account. This action removes a specific template folder. Any email templates that were stored in the folder will not be deleted, but will be marked as 'unfiled' and can still be accessed through the templates list. Important: This is a destructive action and cannot be undone. Make sure you have the correct folder_id before executing. Returns HTTP 204 No Content on successful deletion.

Delete a specific webhook from a Mailchimp audience/list. Permanently removes a webhook configuration that was previously set up to receive POST notifications for list events. This action is irreversible - once deleted, the webhook URL will no longer receive notifications. Returns the deleted webhook object with its configuration details.

Permanently delete an email from a classic automation workflow. This action removes the specified email from an automation workflow. Important limitations: - Emails from Abandoned Cart (abandonedCart) workflows cannot be deleted. - Emails from Product Retargeting (abandonedBrowse) workflows cannot be deleted. - The automation workflow must exist and contain the specified email. Use the list_automations action to get valid workflow_id values. Use the list_automated_emails action to get valid workflow_email_id values.

Forget a contact and remove their personally identifiable information (PII). This action marks a contact to be forgotten and initiates the process to remove their PII from Mailchimp in compliance with GDPR and privacy regulations. Use this when handling "right to be forgotten" requests. The contact will be permanently removed from the audience. Returns HTTP 204 No Content on success with an empty response body.

Remove a member from a static segment in a Mailchimp list/audience. This action removes a list member from a specified static segment. The member remains in the list - they are only removed from the segment membership. Important notes: - Only works with static segments (type='static'), not dynamic/saved segments - Returns HTTP 204 No Content on success - Returns HTTP 404 if the member is not found in the segment - This is an idempotent operation

Remove a subscriber from a classic automation workflow at any point in the sequence. IMPORTANT: Once removed, the subscriber can NEVER be re-added to the same workflow. This action is irreversible. Prerequisites: - The automation must be in 'sending' or 'paused' status (not 'save' or 'archived') - The automation must have a list/audience associated with it - The email address must belong to a subscriber on that list Use MAILCHIMP_LIST_AUTOMATIONS to find workflows and check their status. Use MAILCHIMP_LIST_MEMBERS_INFO to verify subscriber email addresses.

Update a specific order.