Configuring Mailchimp WHMCS Addon

  1. Obtain the plugin.
  2. If you have not already done so, you will need to open an account at www.mailchimp.com and obtain a Mailchimp API key. You can find your Mailchimp API key by logging in to Mailchimp and clicking on your account name in the upper left corner of the screen. Then click “Account Settings” and then “Extras” and API Keys.
  3. Download the Modulized: Mailchimp plugin files from the QiQ server using the instructions from your welcome email.
  4. Upload the files to your WHMCS installation. (yourdomain.com/whmcs/modules/addons/mailchimp).
  5. Log into WHMCS and visit “Setup” → “Addon Modules” and Activate Modulized: Mailchimp. Also click “Configure” to specify access control properties for the plugin.
  6. Within WHMCS goto “Addons” → “Modulized: Mailchimp”.
  7. Enter your Modulized: Mailchimp Addon Licence Key from your welcome email. Enter your Mailchimp API key. Click “Save Configurations”.

Assigning Mailing Lists to Products

  1. Click the “Products” tab within the plugin.
  2. Select your WHMCS product from the WHMCS Product List.
  3. Select the Mailchimp Mailing list(s) you would like users of the product to be subscribed to.
  4. Click “add Mailing Lists”.
  5. If you prefer you can enter the Mailchimp Mailing List ID rather than select from the list.
  6. A summary of products and associated mailing lists are displayed at the foot of the page.

Remove Assigned Mailing Lists on Products

  1. Select the “Delete” tick box alongside the associated mailing list.
  2. Click “Delete Mailing List”.
  3. This does not remove the mailing list from Mailchimp, it simply stops users being subscribed to it.

Assigning Mailing Lists to Domain Names

  1. Click the “Domains” tab within the plugin.
  2. Select the Mailchimp Mailing list(s) you would like domain names to be automatically subscribed to.
  3. Click “add Mailing Lists”.
  4. If you prefer you can enter the Mailchimp Mailing List ID rather than select from the list.
  5. A summary of associated mailing lists are displayed at the foot of the page.

Remove Assigned Mailing Lists to Domain Names

  1. Select the “Delete” tick box alongside the associated mailing list.
  2. Click “Delete Mailing List”.
  3. This does not remove the mailing list from Mailchimp, it simply stops users being subscribed to it.

Assigning Mailing Lists to Product Groups

  1. Click the “Groups” tab within the plugin.
  2. Select your WHMCS Group from the WHMCS Group List.
  3. Select the Mailchimp Mailing list(s) you would like users of the product to be subscribed to.
  4. Click “add Mailing Lists”.
  5. If you prefer you can enter the Mailchimp Mailing List ID rather than select from the list.
  6. A summary of groups and associated mailing lists are displayed at the foot of the page.

Remove Assigned Mailing Lists to Product Groups

  1. Select the “Delete” tick box alongside the associated mailing list.
  2. Click “Delete Mailing List”.
  3. This does not remove the mailing list from Mailchimp, it simply stops users being subscribed to it.

Assigning Mailing Lists to Affiliates

  • Click the “Affiliates” tab within the plugin.
  • Select the Mailchimp Mailing list(s) you would like affiliates to be automatically subscribed to.
  • Click “add Mailing Lists”.
  • If you prefer you can enter the Mailchimp Mailing List ID rather than select from the list.
  • A summary of associated mailing lists are displayed at the foot of the page.

Remove Assigned Mailing Lists to Affiliates

  1. Select the “Delete” tick box alongside the associated mailing list.
  2. Click “Delete Mailing List”.
  3. This does not remove the mailing list from Mailchimp, it simply stops users being subscribed to it.

Export Clients

  1. Click the “Export” tab within the plugin.
  2. Search clients by filter, username or domain names

Search Clients: Filter By

By using the ‘Search Clients: Filter By’ form you can create a CSV file based on the filter settings available within the form.

Search Clients: By Usernames

You can pull out clients data based on user names if you have a list of them. Create a CSV file containing user names, each user name must be on a newline. Additional fields can be passed through within your CSV file, separate additional columns using commas. The user names column must always be the first column in the row. Example below:

username1,col1,col2,col3
username2,col1,col2,col3

Search Clients: By Domain Names

You can pull out clients data based on domain names if you have a list of them. Create a CSV file containing the domain names, each domain name must be on a newline. Additional fields can be passed through within your CSV file, separate additional columns using commas. The domain name column must always be the first column in the row. Example below:

domainname1,col1,col2,col3
domainname2,col1,col2,col3

Problems & Support

We hope you do not experience any problems but if you do these tips may help:

  • If you are experiencing issue check for the error.log located on the root of your addon module as well as the activity log in whmcs to establish what the problem might be.
  • If you encounter a white screen once the application is installed please refer to http://docs.whmcs.com/Blank_Pages to display errors causing the issue.
  • If you are unable to get your install working, please provide full details of the errors you are encountering by emailing support@modulized.com