Installing the MailChimp Module in Drupal

MailChimp can be integrated with Drupal using the MailChimp module. This plugin provides all of the API integration functionality, including the ability to add your MailChimp API key.

The MailChimp Module only provides the core functionality, and sub-modules must be activated and used for additional features.

Prerequisites

  • You have administrator access to your Drupal installation.
  • You have the ability to upload files to your server directly (FTP or via a web-based File Manager)
  • You have a MailChimp account.

Module

You will need the following Drupal Module.

Dependencies

You will need the following Drupal Modules installed for the MailChimp Module to work.

  • Libraries API Drupal Module version 2.0 (also known simply as Libraries)
  • Entity API Drupal Module (sometimes referred to as Entities)

You will also need the following library:

Installation Instructions

Instructions Overview

If you are already familiar with Drupal, or just want an overview of the steps, here is a simplified version of what needs to be done.

  1. Install the latest version of the MailChimp Module in Drupal, and its prerequisites.
  2. Download the MailChimp API Library v2 and extract to the libraries folder.
  3. Activate the Modules in Drupal.
  4. Enter your MailChimp API Key in the Drupal Module.

For step-by-step instructions, see the detailed installation instructions below.

Detailed Step-by-Step Instructions

These instructions were written for Drupal 7, but other versions should be similar.

  1. Visit the MailChimp Module Project page and find the appropriate version.
    • Use the latest recommended release for your version of Drupal.
    • Earlier releases may have different directions, features and dependencies than stated here.
  2. Either download the file, or copy the link (URL) to the download file.
  3. Install the MailChimp Module in Drupal (and its dependencies, if needed).
    1. Visit the Modules Administration page in Drupal.
      • Located at http://example.com/admin/modules
    2. Click on the Install New Module link.
    3. Upload the file from the previous step.
      • Paste the URL if you copied the link.
      • Click Browse and upload the file, if you downloaded it.
    4. Click the Install button.
    5. Follow the on screen instructions for completing the installation.
  4. Download the MailChimp API Library v2 and extract to the libraries folder.
    • Option 1: Using a File Manager (upload then extract method)
      1. Use your File Manager to upload the zip file to the /sites/all/libraries folder.
      2. Extract the zip file.
      3. Rename the folder mailchimp so the final path is /sites/all/libraries/mailchimp
    • Option 2: Using FTP (extract then upload method)
      1. Extract the zip file.
      2. Rename the extracted folder mailchimp
      3. Upload the mailchimp folder and its content to /sites/all/libraries
  5. Activate the Module(s).
    1. Visit the Modules Administration page in Drupal.
      • Located at http://example.com/admin/modules
    2. Check the MailChimp modules you wish to activate (typically all of them).
      • If you haven't already activated Libraries and Entities, you will need to do that now too.
    3. Click on Save Configuration on the bottom of the page.

Configuration

Obtaining Your MailChimp API Key

Before you setup the MailChimp Module, you will need your MailChimp API Key from MailChimp.com.

  1. Login to your MailChimp account.
    • Opening the website in a separate tab or window will make it easier to copy and paste the key later.
  2. Visit your Profile Page.
    • Click on your avatar or name in the top menu bar, and select Profile.
  3. Click on Extras and select API Keys.
  4. If you need a new key, click Create a Key.
    • Optionally click on the label next to the key to change the label. Recommended if you have multiple websites.
  5. When needed, you can copy the key from here and paste it into the Drupal Module configuration page.

Configuring MailChimp in Drupal

After you have the MailChimp API Key, you can configure Drupal.

  1. Configure the module in the Configuration section of Drupal
    • Located at Administration > Configuration > Web Services > MailChimp
    • Direct URL: http://example.com/admin/config/services/mailchimp
    • If you are still on the Module Admin page, you can click on the Configure link next to the MailChimp module.
  2. Enter your MailChimp API Key into Drupal.
  3. Click on Save Configuration before proceeding with other changes.
    • If you don't save the API Key first, some of the other features won't work.

What's Next

As mentioned earlier, the MailChimp module doesn't do much by itself. You will need to configure its various submodules or other modules for various features.

About the Author

WisTex's picture
Scott M. Stolz

Recommended Content