MailChimp | API Docs

<!DOCTYPE html> <html> <head><script type="text/javascript" src="/_static/js/bundle-playback.js?v=HxkREWBo" charset="utf-8"></script> <script type="text/javascript" src="/_static/js/wombat.js?v=txqj7nKC" charset="utf-8"></script> <script>window.RufflePlayer=window.RufflePlayer||{};window.RufflePlayer.config={"autoplay":"on","unmuteOverlay":"hidden"};</script> <script type="text/javascript" src="/_static/js/ruffle/ruffle.js"></script> <script type="text/javascript"> __wm.init("https://web.archive.org/web"); __wm.wombat("http://apidocs.mailchimp.com:80/","20130430183751","https://web.archive.org/","web","/_static/", "1367347071"); </script> <link rel="stylesheet" type="text/css" href="/_static/css/banner-styles.css?v=S1zqJCYt" /> <link rel="stylesheet" type="text/css" href="/_static/css/iconochive.css?v=3PDvdIFv" />  <title>MailChimp | API Docs</title>  <link href="/web/20130430183751cs_/http://apidocs.mailchimp.com/c/site.css" rel="stylesheet" type="text/css"/> </head> <body> <div class="sidebar"> <header class="line"> <a id="logo" href="https://web.archive.org/web/20130430183751/http://mailchimp.com/"> <img height="47" width="178" alt="MailChimp" src="/web/20130430183751im_/http://apidocs.mailchimp.com/i/newlogo.png"/> </a> </header> <aside id="sidebar" class="unit side"> <div class="ab"> <form id="st"> <input type="text" id="st-search-input" class="st-search-input"/> </form> <script type="text/javascript"> var Swiftype = window.Swiftype || {}; (function() { Swiftype.key = '8roboHQKbktmvSy9na82'; Swiftype.inputElement = '#st-search-input'; Swiftype.resultContainingElement = '#st-results-container'; Swiftype.attachElement = '#st-search-input'; Swiftype.renderStyle = "new_page"; Swiftype.resultPageURL = "/search/" var script = document.createElement('script'); script.type = 'text/javascript'; script.async = true; script.src = "//web.archive.org/web/20130430183751/http://swiftype.com/embed.js"; var entry = document.getElementsByTagName('script')[0]; entry.parentNode.insertBefore(script, entry); }()); </script> <nav id="nav" role="navigation"> <ul> <li class="section"> <a href="/web/20130430183751/http://apidocs.mailchimp.com/gettingstarted/connectivity.php">Getting Started</a> <ul> <li><a href="/web/20130430183751/http://apidocs.mailchimp.com/gettingstarted/connectivity.php">General Connectivity</a></li> <li><a href="/web/20130430183751/http://apidocs.mailchimp.com/gettingstarted/serialized_http_arrays.php">Serializing Arrays</a></li> <li><a href="/web/20130430183751/http://apidocs.mailchimp.com/gettingstarted/timeouts.php">Timeouts</a></li> </ul> </li> <li class="section"> <a href="/web/20130430183751/http://apidocs.mailchimp.com/api/how-to/basic-subscribe.php">How To</a> <ul> <li><a href="/web/20130430183751/http://apidocs.mailchimp.com/api/how-to/basic-subscribe.php">Basic Subscribe Form</a></li> <li><a href="/web/20130430183751/http://apidocs.mailchimp.com/api/how-to/serializing.php">Serializing Data</a></li> <li><a href="/web/20130430183751/http://apidocs.mailchimp.com/api/how-to/transactional-campaigns.php">Transactional Email</a></li> <li><a href="/web/20130430183751/http://apidocs.mailchimp.com/api/how-to/sync-you-to-mailchimp.php">Syncing Changes from You to MailChimp</a></li> <li><a href="/web/20130430183751/http://apidocs.mailchimp.com/api/how-to/sync-mailchimp-to-you.php">Syncing Changes from MailChimp to You</a></li> <li><a href="/web/20130430183751/http://apidocs.mailchimp.com/api/how-to/forward-to-a-friend.php">Reproducing Forward-to-Friend Links</a></li> <li><a href="/web/20130430183751/http://apidocs.mailchimp.com/api/how-to/ecommerce.php">Integrating Ecommerce functionality</a></li> </ul> </li> <li class="section"> <a href="/web/20130430183751/http://apidocs.mailchimp.com/api/downloads/">Downloads & API Wrappers</a> <ul> <li><a href="/web/20130430183751/http://apidocs.mailchimp.com/api/downloads/">Standard API</a></li> <li><a href="/web/20130430183751/http://apidocs.mailchimp.com/webhooks/downloads/">Webhooks</a></li> <li><a href="/web/20130430183751/http://apidocs.mailchimp.com/export/downloads/">Export</a></li> <li><a href="/web/20130430183751/http://apidocs.mailchimp.com/api/example-code/">Example Code</a></li> </ul> </li> <li class="section"><a href="/web/20130430183751/http://apidocs.mailchimp.com/api/">MailChimp API</a> <ul> <li><a href="/web/20130430183751/http://apidocs.mailchimp.com/api/1.3/">v1.3</a></li> <li><a href="/web/20130430183751/http://apidocs.mailchimp.com/api/1.2/">v1.2</a></li> <li><a href="/web/20130430183751/http://apidocs.mailchimp.com/api/1.1/">v1.1</a></li> <li><a href="/web/20130430183751/http://apidocs.mailchimp.com/api/changelog.php">changelog</a></li> </ul> </li> <li class="section"> <a href="https://web.archive.org/web/20130430183751/http://help.mandrill.com/" target="_blank">Mandrill SMTP/API</a> </li> <li class="section"> <a href="/web/20130430183751/http://apidocs.mailchimp.com/export/">Export API</a> <ul> <li><a href="/web/20130430183751/http://apidocs.mailchimp.com/export/1.0/">v1.0</a></li> </ul> </li> <li class="section"> <a href="/web/20130430183751/http://apidocs.mailchimp.com/webhooks/">Webhooks</a> </li> <li class="section"> <a href="/web/20130430183751/http://apidocs.mailchimp.com/oauth2/">OAuth2</a> </li> <li class="section"><a href="/web/20130430183751/http://apidocs.mailchimp.com/partnerapi/">Partner API</a> <ul> <li><a href="/web/20130430183751/http://apidocs.mailchimp.com/partnerapi/1.3/">v1.3</a></li> </ul> </li> <li class="section"> <a href="/web/20130430183751/http://apidocs.mailchimp.com/api/faq/">FAQ</a> </li> <li class="section"> <a href="/web/20130430183751/http://apidocs.mailchimp.com/help/">Support</a> </li> </ul> </nav> </div> </aside> </div> <div class="container"> <header class="line "> <div class="unit"> <div class=""> <hgroup class="in"> <h1><a href="/web/20130430183751/http://apidocs.mailchimp.com/">API Documentation</a></h1> </hgroup> </div> </div> <div class="right"> <div class=""> <a href="https://web.archive.org/web/20130430183751/https://login.mailchimp.com/" class="login">Log In <span></span></a> </div> </div> </header> <section class="line wrapper "> <div id="main"> <div class="in ab double"> <div> <section> <div class="padtop main" data-swiftype-index="true"> <section> <h1>Add MailChimp to Your Website or App</h1> <p>Create integrations that connect MailChimp to a CMS, blog, shopping cart, and more. Our API offers in-depth documentation, a download section for various wrappers, and how-to documents. The majority of data and functionality within our web application is accessible, so the integration possibilities are endless. </p> </section> <section> <h2>Nerds Only!</h2> <p><strong>Not a programmer?</strong> Here are a few options that don't involve using our API directly:</p> <p>If you're not a programmer and you don't have one in your company that you can bribe, there are a few options: <ul class="bullets"> <li><a href="https://web.archive.org/web/20130430183751/http://connect.mailchimp.com/" target="_blank">Check our integrations directory</a> to see if there's already a plugin or integration that you can use.</li> <li><a href="https://web.archive.org/web/20130430183751/http://experts.mailchimp.com/" target="_blank">Hire a MailChimp Expert</a> to assist you with the programming/integration for your project</li> </ul> </p> </section> <section> <h2 class="margintop">Getting Started</h2> <p> Our Getting Started information explains the basics of using Web/HTTP APIs, and MailChimp's in particular. If you haven't worked with our Web/HTTP before, please take a moment to read about <a href="/web/20130430183751/http://apidocs.mailchimp.com/gettingstarted/connectivity.php">sending and receiving data</a>, <a href="/web/20130430183751/http://apidocs.mailchimp.com/gettingstarted/serialized_http_arrays.php">serializing data in HTTP requests</a>, and <a href="/web/20130430183751/http://apidocs.mailchimp.com/gettingstarted/timeouts.php">handling timeouts</a>. </p> </section> <section> <h2 class="margintop">What You Can Do with the API</h2> <p>The <a href="/web/20130430183751/http://apidocs.mailchimp.com/api/">MailChimp API</a> allows you to sync your database with MailChimp for better list and campaign management. Create client portals, add a subscribe form to your checkout page, segment campaigns based on purchase history, link campaign stats to your database, sync email activity with your database, and more.</p> <ul class="bullets"> <li> <a href="https://web.archive.org/web/20130430183751/http://help.mandrill.com/">Mandrill</a> is our transactional email service </li> <li> <a href="/web/20130430183751/http://apidocs.mailchimp.com/oauth2/">OAuth2</a> handles usernames and passwords so you don't have to. </li> <li> <a href="/web/20130430183751/http://apidocs.mailchimp.com/export/">Export API</a> allows you to stream large amounts of data out of our servers since normal API calls are buffered. </li> <li> <a href="/web/20130430183751/http://apidocs.mailchimp.com/webhooks/">Webhooks</a> allow you to collect information in real time. Provide a URL, decide when and where you want that URL to receive data about supported events, and we'll send over the data as things happen. </li> </ul> </section> <section> <h2 class="margintop">Want to Get Paid for This?</h2> <p>We love to see developers building integrations on MailChimp's platform. That's why we created the million-dollar integration fund, which helps pay for those projects. The fund applies to new integrations and plugins, as well as developments that make existing integrations and plugins more effective.</p> <p>We apply funds on a per-project basis, and the total amount we provide depends on the project and its needs. Interested in integrating? Apply for the fund <a href="https://web.archive.org/web/20130430183751/http://mailchimp.com/about/integration-fund/" target="_blank">right here</a>.</p> </section> <section> <h2 class="margintop">Help</h2> <p>Find answers to common questions in our <a href="/web/20130430183751/http://apidocs.mailchimp.com/api/faq/">FAQ</a>, or join our <a href="/web/20130430183751/http://apidocs.mailchimp.com/help/">Google Group</a> for questions and discussions about MailChimp's API. If you have questions that aren't related to the API, visit MailChimp's <a href="https://web.archive.org/web/20130430183751/http://kb.mailchimp.com/">support center</a> to email or chat with someone from tech support.</p> </section> </div> </section> </div> </div> </div> </section> <footer> <div class="footer-content"> <div class="line"> <div class="unit size1of4"> <div class="in"> <h5>About Us</h5> <ul> <li> <a href="https://web.archive.org/web/20130430183751/http://mailchimp.com/about"> About MailChimp </a> </li> <li> <a href="https://web.archive.org/web/20130430183751/http://mailchimp.com/about/jobs"> Jobs </a> </li> <li> <a href="https://web.archive.org/web/20130430183751/http://mailchimp.com/about/customer-stories"> Customer Stories </a> </li> <li> <a href="https://web.archive.org/web/20130430183751/http://mailchimp.com/about/press-resources"> Press Resources </a> </li> <li> <a href="https://web.archive.org/web/20130430183751/http://mailchimp.com/about/press-releases"> Press Releases </a> </li> <li> <a href="https://web.archive.org/web/20130430183751/http://mailchimp.com/about/integration-fund"> Integration Fund </a> </li> <li> <a href="https://web.archive.org/web/20130430183751/http://mailchimp.com/about/brand-assets"> Brand Assets </a> </li> </ul> </div> </div> <div class="unit size1of4"> <div class="in"> <h5>Connect With Us</h5> <ul> <li> <a href="https://web.archive.org/web/20130430183751/http://connect.mailchimp.com/"> Integrations & Plugins </a> </li> <li> <a href="https://web.archive.org/web/20130430183751/http://mailchimp.com/api"> MailChimp API </a> </li> <li> <a href="https://web.archive.org/web/20130430183751/http://mailchimp.com/labs"> MailChimp Labs </a> </li> </ul> </div> </div> <div class="unit size1of4"> <div class="in"> <h5>Contact Us</h5> <ul> <li> <a href="https://web.archive.org/web/20130430183751/http://kb.mailchimp.com/contact"> Contact MailChimp </a> </li> <li> <a href="https://web.archive.org/web/20130430183751/http://mailchimp.com/contact/partnerships"> Partner With Us </a> </li> <li> <a href="https://web.archive.org/web/20130430183751/http://mailchimp.com/contact/abuse"> Abuse Desk </a> </li> <li> <a href="https://web.archive.org/web/20130430183751/http://status.mailchimp.com/"> MailChimp Status </a> </li> <li> <a href="https://web.archive.org/web/20130430183751/http://experts.mailchimp.com/"> Find an Expert </a> </li> </ul> </div> </div> <div class="unit size1of4"> <div class="in"> <h5>Legal Info</h5> <ul> <li> <a href="https://web.archive.org/web/20130430183751/http://mailchimp.com/legal/terms"> Terms of Use </a> </li> <li> <a href="https://web.archive.org/web/20130430183751/http://mailchimp.com/legal/privacy"> Privacy Policy </a> </li> <li> <a href="https://web.archive.org/web/20130430183751/http://mailchimp.com/legal/copyright"> Copyright Policy </a> </li> </ul> </div> </div> </div> <div class="line"> <div class="colophon"> <p>© 2001-2012 All Rights Reserved. MailChimp® is a registered trademark of The Rocket Science Group</p> </div> </div> </div> </footer> </div>  <script src="https://web.archive.org/web/20130430183751js_/http://code.jquery.com/jquery-1.7.2.min.js"></script> <script src="/web/20130430183751js_/http://apidocs.mailchimp.com/js/gen.js"></script> <script type="text/javascript"> var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-329148-81']); _gaq.push(['_setDomainName', '.mailchimp.com']); _gaq.push(['_addIgnoredRef', 'mailchimp.com']); _gaq.push(['_addIgnoredOrganic', 'mailchimp.com']); _gaq.push(['_trackPageview']); (function() { var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; ga.src = ('https:' == document.location.protocol ? 'https://web.archive.org/web/20130430183751/https://ssl' : 'https://web.archive.org/web/20130430183751/http://www') + '.google-analytics.com/ga.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); })(); </script> </body> </html>

CINXE.COM

MailChimp | API Docs