devot:eeDevoted to ExpressionEngine

Freeform extension that adds new subscribers to multiple Campaign Monitor or MailChimp subscriber lists. You can either add everyone or people who have a particular value in a field (such as a checkbox). Formerly known as WB Freeform Campaign Monitor.

If you’re looking for the ExpressionEngine 1.x version of this extension, I recently made it available for free on GitHub. Also, a page on Devot:ee will be available shortly.

Recently Added

• Added provider independent fields (name for Campaign Monitor versus first and last name for MailChimp)
• Can now check multiple Subscriber forms and therefore add to different MailChimp and Campaign Monitor lists at the same time
• Added the ability to duplicate existing Subscriber forms
• Clarified error when trying to install Subscriber when Freeform is not installed

Setup

You’ll need a few things before we start:

• Your API Key. Both Campaign Monitor and MailChimp have very good documentation on where to find these:
   - Campaign Monitor
   - MailChimp
  
• Your List ID. To find this:
   - Campaign Monitor
   - MailChimp
  

Then, to set it all up:

 
1. Enable the Freeform module
 
2. Enable the Subscriber module and extension
 
3. Go to the settings page for the Subscriber module
 
4. Create a new form using the Create New Form button
 
5. Select a newsletter provider
 
6. Enter your API Key and your List ID
 
7. Choose your Add Method:
    - Everyone adds everyone who submits a form with a valid name and email address to the subscriber list.
    - Switch field lets you determine whether to add someone based on another field, for example a checkbox, radio group or other field’s value.  
 
8. Enter the name of the Name input element (e.g. <input type=“text” name=”subscriber_name” />)
 
9. Enter the name of the Email input element (e.g. <input type=“text” name=”subscriber_email” />)

If you choose the Switch Field Add Method, you’ll need to enter a bit more information:

 
1. Enter the name of the Switch input element (e.g. <input type=“checkbox” value=“yes” name=”subscribe_to_newsletter” />)
 
2. Enter the value of the Switch input element (e.g. <input type=“checkbox” value=”yes” name=“subscribe_to_newsletter” />)
 
3. Back on the Module’s Dashboard, copy the form token and paste that into your Freeform form.

Example

{exp:freeform:form
  collection=“Contact Us”
  required=“name|email|message”
  notify=“you@your-domain.com 
  return=“thanks”
}
    {exp:subscriber:form form_id=“1”}
    <input type="text" name="name" />
    <input type="email" name="email" />
    <textarea name="message"></textarea>
    {!--
        Switch field: subscribe_to_newsletter
        Switch value: yes
    --}
    <input type="checkbox" name="subscribe_to_newsletter" value="yes" />
{/exp:freeform:form}

In addition to using just one subscriber form tag, you can use multiple tags or you can put several `form_ids` into one tag:

{exp:subscriber:form form_id="1|2|3"}
	
OR

{exp:subscriber:form form_id="1"}
{exp:subscriber:form form_id="2"}
{exp:subscriber:form form_id="3"}

Settings

Main Settings

• API Key: Your API Key. To find this look at your provider’s documentation:
   - Campaign Monitor
   - MailChimp
  
• List ID: Your List ID. To find this look at your provider’s documentation:
   - Campaign Monitor
   - MailChimp
  
• Add Method: Why the user is added. Can either be everyone or based upon a switch field.
• Name Input Field Name: The field name for the person’s name.
• Email Input Field Name: The field name for the person’s email.

Switch Settings

• Switch Input Field Name: The field name that will determine if the person is subscribed to the list.
• Switch Input Field Value: The value we’re looking for in the switch input field.

Custom Fields

For Campaign Monitor: Create the custom field in your Campaign Monitor Subscriber List. Once you’ve done that, copy the Personalization Tag for that field. For example, if the field was “My Custom Field’, your Personalization Tag will probably look like [MyCustomField, fallback=]. All you need from that is the MyCustomField.

Also, if you have any multiple option custom fields in your Campaign Monitor list, you’ll need to check the checkbox in the custom fields table and make sure that your form field’s name has brackets after the name. For example:

<select name="options[]" multiple>

For MailChimp: Create the custom fields by going to your list’s settings and then List Fields and *|MERGE|* Tags. Once you’ve created the custom fields you want, copy the tag under the Stick this tag in your content: column.

Armed with that information, go configure the extension and add both the name of the field and the corresponding Tag to the extension’s settings.

• Custom Field: The custom field’s input name.
• Custom Field Tag: The custom field’s tag in Campaign Monitor or MERGE tag from MailChimp.
• Multiple Options?: (Campaign Monitor Only) If your list has a custom field that has multiple options, check this checkbox.

This entry was last updated April 27, 2012, 3:53 am.

Disclaimer: Information about ExpressionEngine add-ons is provided as a service to you, the user, and every member of the ExpressionEngine community. Devot:ee is not responsible if you hose, mangle, wreck, or otherwise destroy your EE website by installing an add-on that you found out about at this site, regardless of its rating, Favorites status, commercial or free status, or general popularity. Caveat EEmptor!