Marketing API

  • API Root

    The API root resource links to all other resources available in the API. Calling the root directory also returns details about the Mailchimp user account.

    Improve our docs onGitHub
    • Authorized Apps

      Manage registered, connected apps for your Mailchimp account with the Authorized Apps endpoints.

      Improve our docs onGitHub
      • Automations

        Mailchimp's free Automation feature lets you build a series of emails that send to subscribers when triggered by a specific date, activity, or event. Use the API to manage Automation workflows, emails, and queues.

        Improve our docs onGitHub
        • Automations

          Emails

          Manage individual emails in an Automation workflow.

          Improve our docs onGitHub
        • Automations

          Queue

          Manage list member queues for Automation emails.

          Improve our docs onGitHub
        • Automations

          Removed Subscribers

          Remove subscribers from an Automation workflow.

          Improve our docs onGitHub
      • Batch Operations

        Use batch operations to complete multiple operations with a single call.

        Improve our docs onGitHub
        • Batch Webhooks

          Manage webhooks for batch operations.

          Improve our docs onGitHub
          • Campaign Folders

            Organize your campaigns using folders.

            Improve our docs onGitHub
            • Campaigns

              Campaigns are how you send emails to your Mailchimp list. Use the Campaigns API calls to manage campaigns in your Mailchimp account.

              Improve our docs onGitHub
              • Campaigns

                Content

                Manage the HTML, plain-text, and template content for your Mailchimp campaigns.

                Improve our docs onGitHub
              • Campaigns

                Feedback

                Post comments, reply to team feedback, and send test emails while you're working together on a Mailchimp campaign.

                Improve our docs onGitHub
              • Campaigns

                Send Checklist

                Review the send checklist for your campaign, and resolve any issues before sending.

                Improve our docs onGitHub
            • Chimp Chatter Activity

              Get the latest Chimp Chatter activity from your account.

              Improve our docs onGitHub
              • Connected Sites

                Manage sites you've connected to your Mailchimp account.

                Improve our docs onGitHub
                • Conversations

                  Conversation tracking lets you view subscribers' replies to your campaigns in your Mailchimp account.

                  Improve our docs onGitHub
                  • Conversations

                    Messages

                    Manage messages in a specific campaign conversation.

                    Improve our docs onGitHub
                • E-commerce Stores

                  Connect your E-commerce Store to Mailchimp to take advantage of powerful reporting and personalization features and to learn more about your customers.

                  Improve our docs onGitHub
                  • E-commerce Stores

                    Cart Lines

                    Each Cart contains one or more Cart Lines, which represent a specific Product Variant that a Customer has added to their shopping cart.

                    Improve our docs onGitHub
                  • E-commerce Stores

                    Carts

                    Use Carts to represent unfinished e-commerce transactions. This can be used to create an Abandoned Cart workflow, or to save a consumer’s shopping cart pending a successful Order.

                    Improve our docs onGitHub
                  • E-commerce Stores

                    Customers

                    Add Customers to your Store to track their orders and to view E-Commerce Data for your Mailchimp lists and campaigns. Each Customer is connected to a Mailchimp list member, so adding a Customer can also add or update a list member.

                    Improve our docs onGitHub
                  • E-commerce Stores

                    Order Lines

                    Each Order contains one or more Order Lines, which represent a specific Product Variant that a Customer purchases.

                    Improve our docs onGitHub
                  • E-commerce Stores

                    Orders

                    Orders represent successful e-commerce transactions, and this data can be used to provide more detailed campaign reports, track sales, and personalize emails to your targeted consumers, and view other e-commerce data in your Mailchimp account.

                    Improve our docs onGitHub
                  • E-commerce Stores

                    Product Images

                    A Product Image represents a specific product image.

                    Improve our docs onGitHub
                  • E-commerce Stores

                    Product Variants

                    A Product Variant represents a specific item for purchase, and is contained within a parent Product. At least one Product Variant is required for each Product.

                    Improve our docs onGitHub
                  • E-commerce Stores

                    Products

                    E-commerce items for sale in your store need to be created as Products so you can add the items to a Cart or an Order. Each Product requires at least one Product Variant.

                    Improve our docs onGitHub
                  • E-commerce Stores

                    Promo Codes

                    Promo codes can be created for a given price rule. All the promo codes under a price rule share the generic information defined for that rule like the amount, type, expiration date etc. Promo code defines the more specific information about a promo code like the actual code, redemption_url, usage_count, etc that's unique to a code. Promo Code must be defined under a promo rule.

                    Improve our docs onGitHub
                  • E-commerce Stores

                    Promo Rules

                    Promo Rules help you create promo codes for your campaigns. Promo Rules define generic information about promo codes like expiration time, start time, amount of discount being offered etc. For a given promo rule you can define if it's a percentage discount or a fixed amount and if it applies for the order as a whole or if it's per item or free shipping. You can then create promo codes for this price rule. Promo codes contain the actual code that is applied at checkout along with some other information. Price Rules have one to many relationship with promo codes.

                    Improve our docs onGitHub
                • Facebook Ads

                  Get information about Facebook Ads.

                  Improve our docs onGitHub
                  • File Manager Files

                    Manage specific files in the File Manager for your Mailchimp account. The File Manager is a place to store images, documents, and other files you include or link to in your campaigns, templates, or signup forms.

                    Improve our docs onGitHub
                    • File Manager Folders

                      Manage specific folders in the File Manager for your Mailchimp account. The File Manager is a place to store images, documents, and other files you include or link to in your campaigns, templates, or signup forms.

                      Improve our docs onGitHub
                      • Landing Pages

                        Manage your Landing Pages, including publishing and unpublishing.

                        Improve our docs onGitHub
                        • Landing Pages

                          Content

                          The HTML content for your Mailchimp landing pages.

                          Improve our docs onGitHub
                      • Lists/Audiences

                        Your Mailchimp list, also known as your audience, is where you store and manage all of your contacts.

                        Improve our docs onGitHub
                        • Lists/Audiences

                          Abuse Reports

                          Manage abuse complaints for a specific list. An abuse complaint occurs when your recipient reports an email as spam in their mail program.

                          Improve our docs onGitHub
                        • Lists/Audiences

                          Activity

                          Get recent daily, aggregated activity stats for your list. For example, view unsubscribes, signups, total emails sent, opens, clicks, and more, for up to 180 days.

                          Improve our docs onGitHub
                        • Lists/Audiences

                          Clients

                          Get information about the most popular email clients for subscribers in a specific Mailchimp list.

                          Improve our docs onGitHub
                        • Lists/Audiences

                          Events

                          Use the Events endpoint to collect website or in-app actions and trigger targeted automations.

                          Improve our docs onGitHub
                        • Lists/Audiences

                          Growth History

                          View a summary of the month-by-month growth activity for a specific list.

                          Improve our docs onGitHub
                        • Lists/Audiences

                          Interest Categories

                          Manage interest categories for a specific list. Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to 'group titles' in the Mailchimp application.

                          Improve our docs onGitHub
                        • Lists/Audiences

                          Interests

                          Manage interests for a specific Mailchimp list. Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application.

                          Improve our docs onGitHub
                        • Lists/Audiences

                          Locations

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

                          Improve our docs onGitHub
                        • Lists/Audiences

                          Member Activity

                          Get details about a subscriber's recent activity. Use the new activity-feed endpoint to access more events for a given contact.

                          Improve our docs onGitHub
                        • Lists/Audiences

                          Member Activity Feed

                          Get details about a subscriber's recent activity.

                          Improve our docs onGitHub
                        • Lists/Audiences

                          Member Goals

                          Get information about recent goal events for a specific list member.

                          Improve our docs onGitHub
                        • Lists/Audiences

                          Member Notes

                          Retrieve recent notes for a specific list member.

                          Improve our docs onGitHub
                        • Lists/Audiences

                          Member Tags

                          Manage all the tags that have been assigned to a contact.

                          Improve our docs onGitHub
                        • Lists/Audiences

                          Members

                          Manage members of a specific Mailchimp list, including currently subscribed, unsubscribed, and bounced members.

                          Improve our docs onGitHub
                        • Lists/Audiences

                          Merge Fields

                          Manage merge fields (formerly merge vars) for a specific list.

                          Improve our docs onGitHub
                        • Lists/Audiences

                          Preview Segment

                          Provide conditions to preview segment.

                          Improve our docs onGitHub
                        • Lists/Audiences

                          Segment Members

                          Manage list members in a saved segment.

                          Improve our docs onGitHub
                        • Lists/Audiences

                          Segments

                          Manage segments and tags for a specific Mailchimp list. A segment is a section of your list that includes only those subscribers who share specific common field information. Tags are labels you create to help organize your contacts.

                          Improve our docs onGitHub
                        • Lists/Audiences

                          Signup Forms

                          Manage list signup forms.

                          Improve our docs onGitHub
                        • Lists/Audiences

                          Webhooks

                          Manage webhooks for a specific Mailchimp list.

                          Improve our docs onGitHub
                      • Ping

                        A health check endpoint for Mailchimp API 3.0.

                        Improve our docs onGitHub
                        • Reporting

                          Reporting for Facebook Ads and Landing Pages.

                          Improve our docs onGitHub
                          • Reporting

                            Ecommerce Product Activity

                            Ecommerce product activity report for a Facebook Ad.

                            Improve our docs onGitHub
                          • Reporting

                            Facebook Ads

                            Get information about Facebook Ad reports.

                            Improve our docs onGitHub
                          • Reporting

                            Landing Pages

                            Get information about Landing Page reports.

                            Improve our docs onGitHub
                        • Reports

                          Manage campaign reports for your Mailchimp account. All Reports endpoints are read-only. Mailchimp's campaign and Automation reports analyze clicks, opens, subscribers' social activity, e-commerce data, and more. Note: Campaign IDs for A/B Testing Campaigns are available through the Campaign API Endpoint's Read method.

                          Improve our docs onGitHub
                          • Reports

                            Campaign Abuse

                            Get information about campaign abuse complaints.

                            Improve our docs onGitHub
                          • Reports

                            Campaign Advice

                            Get recent feedback based on a campaign's statistics.

                            Improve our docs onGitHub
                          • Reports

                            Campaign Open Reports

                            Get a detailed report about any emails in a specific campaign that were opened by the recipient.

                            Improve our docs onGitHub
                          • Reports

                            Click Reports

                            Get detailed information about links clicked in campaigns.

                            Improve our docs onGitHub
                          • Reports

                            Click Reports Members

                            Get information about specific subscribers who clicked on links in a campaign.

                            Improve our docs onGitHub
                          • Reports

                            Domain Performance

                            Get statistics for the top-performing domains from a campaign.

                            Improve our docs onGitHub
                          • Reports

                            Ecommerce Product Activity

                            Ecommerce product activity report for a campaign.

                            Improve our docs onGitHub
                          • Reports

                            EepURL Reports

                            Get a summary of social activity for the campaign, tracked by EepURL.

                            Improve our docs onGitHub
                          • Reports

                            Email Activity

                            Get list member activity for a specific campaign.

                            Improve our docs onGitHub
                          • Reports

                            Location

                            Get top open locations for a specific campaign.

                            Improve our docs onGitHub
                          • Reports

                            Sent To

                            Get details about campaign recipients.

                            Improve our docs onGitHub
                          • Reports

                            Sub-Reports

                            A list of reports for child campaigns of a specific parent campaign. For example, use this endpoint to view Multivariate, RSS, and A/B Testing Campaign reports.

                            Improve our docs onGitHub
                          • Reports

                            Unsubscribes

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

                            Improve our docs onGitHub
                        • Search Campaigns

                          Search all of an account's campaigns for the specified query terms.

                          Improve our docs onGitHub
                          • Search Members

                            Search the account or a specific list for members that match the specified query terms.

                            Improve our docs onGitHub
                            • Template Folders

                              Organize your templates using folders.

                              Improve our docs onGitHub
                              • Templates

                                Manage your Mailchimp templates. A template is an HTML file used to create the layout and basic design for a campaign.

                                Improve our docs onGitHub
                                • Templates

                                  Default Content

                                  Manage the default content for a Mailchimp template.

                                  Improve our docs onGitHub
                              • Verified Domains

                                Manage the domains on your account that can be used for sending email campaigns.

                                Improve our docs onGitHub