This article provides a brief introduction to using the Caldera Forms MailChimp add-on. For a full walk through on creating a contact form with MailChimp integration, see this article.
Please note, this documentation has been updated for version 1.3 of the add-on.
Easily integrate conditional based newsletter signups within your forms through your MailChimp account.
Using Conditionals, you can add multiple MailChimp processors to a single form and have them signup depending on user input. This makes it easy to have a single form have signup options for multiple lists.
Populate MailChimp custom fields with data from the current form, or based on current user, or even the current post to MailChimp using Caldera Forms magic tags.
Using the Caldera Forms MailChimp Add-on
The add-on is a Form Processor. This means you can add it to any form via the Processors tab in the form builder.
See the clip below to demonstrate the setup process. NOTE: The “Conditionals” step is optional. It can be used to set it only if the user checks a box. Not setting a conditional, the processor will be used on every submission.
You will begin by entering your MailChimp API key. Once you provide a valid key, Caldera Forms will find each of your lists. Once you select a list, you will see the basic and custom fields (if set) for the list.
At a minimum, you must set the email setting and the first name setting. The email setting can only be mapped to an email field or the user email magic tag. Be careful of using the current user email magic tag as it will cause the form to fail when no user is logged in.
Using Custom MailChimp Fields
If you have added custom fields to your list in MailChimp, when you select the list, settings for those fields will appear in the processor settings. If you have custom fields in your list, you can set their values from your Caldera Form. Please keep the following in mind:
- You can only map Caldera Forms fields to MailChimp fields of the same type.
- If you have a dropdown field in your list, the values (not labels) of the Caldera Forms field mapped to the MailChimp field must be exactly the same as the values (not labels) of the MailChimp field or you will encounter errors.
Setting Subscriber Status
MailChimp provides for a “Double Opt-In” process. When you use this process, the subscriber is added to your list as “pending” and is sent a confirmation email with a link they must click before being subscribed to the list. The Subscriber Status setting in the Caldera Forms MailChimp processor can be used to use or bypass double opt-in.
This field has three settings:
- Subscribed – This will add subscribers to the list. This will bypass the MailChimp double opt-in process.
- Pending – This will make the subscriber a “pending” member of the list. They will have to complete the double opt-in process.
- Unsubscribed – This will remove the subscriber from the list. Use this for creating MailChimp list unsubscribe forms.
This setting is available in Caldera Forms MailChimp 1.4 or later. In 1.2.x and earlier, there was a checkbox to enable double opt-in. In 1.3.x, you can use a filter to enable double opt-in.
Using MailChimp Segments With Caldera Forms
Caldera Forms MailChimp can be used to add mailing list members to a segment or interest groups that you can use for dynamic segmentation. Segmentation helps you categorize the visitors who sign up for your MailChimp list on your WordPress list, based on what they signed up for, and tailor unique marketing messages to each segment.
Once you have entered your API key, and then selected a link, you will see a select option for Segment. You can use this selector to choose the static segment to add the new list member to. For more information on using static segments, see this doc.
You can also add subscribers to interest groups, that you can then use to create dynamic segments in MailChimp. This process is documented here.