Mailchimp for FormIt

Package Description

This extra adds subscribers to Mailchimp lists using FormIt and the Mailchimp API. It adds a snippet for retrieving Mailchimp lists in a single select TV and a FormIt hook for subscribing Mailchimp users to the list provided in the pages Template Variable

**Free Extra** This is a free extra and the code is publicly available for you to change. The extra is being actively maintained and you're free to put in pull requests which match our roadmap. Please create an issue if the pull request differs from the roadmap so we can make sure we're on the same page. Need help? Approach our support desk for paid premium support.

Usage/Installation Instructions

Package for subscribing users in Mailchimp lists using FormIt.

Adds a snippet for retrieving Mailchimp lists in a single select TV and a

FormIt hook for subscribing Mailchimp users to the list provided in the pages Template Variable.

Functionalities

* FormIt hook for subscribing users to Mailchimp lists based on TV value

* MailChimpGetLists: Snippet for creating a select list of MailChimp lists.

How to get set up

* Add MailChimp API Key in systemsettings: mailchimpsubscribe.mailchimp_api_key

* Create a new single select TV variable and set the input option values to:

    @EVAL return $modx->runSnippet('MailChimpGetLists');

* Add MailChimp List ID TV in systemsettings: mailchimpsubscribe.list_tv

* Add MailChimpSubscribe to your FormIt hooks

* Add in your chunk the placeholder fi.error.mailchimp, which holds all MailChimp error messages.

* Add a field called newsgroup, if the value of this field is set to yes, the user will be subscribed to the mailchimp list.

Properties

* mailchimpListId: Mailchimp List ID.

* mailchimpFields: Configuration containing the field mapping between FormIt form and Mailchimp merge tags.

* mailchimpSubscribeField: Field name to use for subscribing users to mailchimp.

* mailchimpSubscribeFieldValue: Field value to use for subscribing users to mailchimp.

Example usage

`

&validationErrorMessage=`true`

&store=`1`

&submitVar=`newsletter-submit`

&mailchimpListId=`12345678abc`

&mailchimpFields=`name=FNAME,email=EMAIL`

&mailchimpSubscribeField=`newsletter`

&mailchimpSubscribeFieldValue=`1`