The MailChimp Sync extension for WP-CRM System has only a few settings you will need to configure before you can start to fully use the plugin.

MailChimp API Key

The MailChimp API Key is a required setting in order for WP-CRM System to communicate with your MailChimp account. Without this, no connection between MailChimp and your WP-CRM System site can be made.

To generate an API key, you must have a MailChimp account with either Manager, Admin, or Owner permissions. Viewer or Authors on your account will not be able to generate an API key.

  • In your MailChimp account, click your profile name at the top right-hand side of the page, and choose Account.
  • Click the Extras drop down menu and choose API Keys.
  • Click the Create A Key button.
  • Enter a descriptive label for your API key so you can remember which application uses that key later on. Something like WP-CRM System would work - really it can be anything though.
  • Copy the API key that was generated for you.

Return to your WP-CRM System site and enter your API key in the plugin's settings.

  • Navigate to WP-CRM System > Dashboard, then click the MailChimp tab.
  • Paste the API key you just generated in the MailChimp API key field.

MailChimp List ID

The MailChimp List ID lets MailChimp know which list you want to communicate with.

  • Click Lists from the top menu.
  • Click on the name of the list you want contacts to be subscribed to.
  • Click the Settings drop down menu and choose List name and defaults.
  • Your list ID will be located under the section that says List ID. Copy the ID.

Return to your WP-CRM System site and enter your List ID in the plugin's settings.

  • Navigate to WP-CRM System > Dashboard, then click the MailChimp tab.
  • Paste the List ID you just found in the MailChimp List ID field.

Subscribe or Confirm

You have two options Subscribe or Pending.

  • Subscribe: Automatically subscribes contacts to your MailChimp list with no confirmation from your contacts as to whether or not they wish to subscribe. It is assumed that you have the contact's permission to subscribe them to your list. Please be sure that you actually have permission to subscribe them to your list, or you may be in violation of MailChimp's terms of use and could have your account disabled.
  • Pending: If you do not have permission and would like to verify that the contact actually wants to be on your list, select this option. It will send a "welcome" email to your subscribers asking them to confirm that they would like to be added to your list.
    • To edit the welcome email sent to your subscribers:
      • Click Lists from the top menu.
      • Click on the name of the list you want contacts to be subscribed to.
      • Click Signup Forms.
      • Click General Forms.
      • Select Opt-in confirmation email from the first select menu.
      • Edit as necessary.


There are a couple benefits to sending a confirmation first before subscribing someone to your list. First, you can confirm that the email address you have on file is a valid address. Second, you will be less likely to receive spam complaints if the contact knows that they subscribed to your mailing list. Too many spam complaints could get your MailChimp account in hot water, so be careful who you are subscribing to your list.

MailChimp Merge Fields

These fields are optional, and can easily be left empty and still be able to send data to your MailChimp list.

On the other hand, you may want to have additional information sent to MailChimp about each of your contacts.

For example, it's sometimes nice to personalize emails with the recipient's name:

Dear Sally,

You may already collect other information about your mailing list's subscribers like the company they work for, or their phone numbers. If you want to pass any of the information you have on file for your contact to MailChimp, simply fill in the appropriate Merge Field from your list.

To find your list's Merge Fields:

  • Click Lists from the top menu.
  • Click on the name of the list you want contacts to be subscribed to.
  • Click Settings and select List fields and *|MERGE|* tags.
  • Find and copy the appropriate tag in the list provided, or click Add A Field to add a new tag if the one you want doesn't already exist.
    • Email Address: This merge tag is required by MailChimp, and can't be changed by you. Therefore we hard coded this merge tag into the plugin's settings so you don't have to worry about entering it.
    • When copying a tag, you can copy either the tag in the text box, or the MERGE# tag. In the screenshot below, FNAME or MERGE1 would work for the list shown.
    • Do not copy the *| or |* symbols surrounding the tag.

Return to your WP-CRM System site and enter your Merge Tag in the plugin's settings.

  • Navigate to WP-CRM System > Dashboard, then click the MailChimp tab.
  • Paste the Merge Tag you just found in the appropriate Merge Field box.

Multiple Lists

In version 3.0 of the MailChimp Sync extension, we added support for multiple lists. The settings are the same as described above. Once you enter your information for the first list and save the settings, you will be presented with a new set of fields for an additional list. Simply repeat the steps above to enter the List ID, the subscribe/confirm option, and any merge tags you want to pass along. Save the changes, and a new set of fields will be presented to you should you want to add additional fields. Repeat as needed.

Custom Fields

If you are using our Custom Fields extension, we have added support for those fields to be synced to your MailChimp list as well. To do this:

  • Create a custom field that is applied to your Contacts in the Custom Fields settings.
  • Repeat for however many custom fields you require.
  • In the MailChimp settings (WP-CRM System > Dashboard > MailChimp) you will see your custom field(s) listed after all of the default fields.
  • Enter the merge tag (see above) from your MailChimp list that relates to the field you want to sync to.
  • Save Changes