This knowledge base article relates to the WS Form MailPoet add-on. Included with the Freelance & Agency editions or buy separately for the personal edition.

The MailPoet add-on lets you use WS Form to create forms that subscribe or unsubscribe contacts in MailPoet. You can create forms for MailPoet lists in a single click!

The MailPoet add-on requires WS Form PRO.

You can learn more about MailPoet WordPress plugin by clicking here.


The WS Form PRO MailPoet add-on plugin is installed in the same way as installing the WS Form PRO plugin.

Once installed you will need to activate the license for the plugin. When you purchase the WS Form MailPoet add-on plugin, you will be given a license key. If you have lost your license key(s), click here.

To activate your license key:

  1. Click WS Form in the WordPress administration menu.
  2. Click Settings.
  3. Click the MailPoet tab at the top of the page.
  4. Enter your license key.
  5. Click the Activate button.

If your license key fails to activate, please ensure you are using the correct license key and not your WS Form PRO license key.

Creating a Form for MailPoet


WS Form can create a form for any of your MailPoet lists in a single click. This process not only creates a form but also fully configures WS Form so that the form is ready to use immediately.

To create a MailPoet form in WS Form:

  1. Click WS Form in the WordPress administration menu.
  2. Click Add New.
  3. Select the MailPoet tab at the top of the page.
  4. Click on any of your MailPoet lists to create a form.
  5. Wait a few moments while the form is created.

That’s it! Your form will be created and is ready to add to your website.

If your list does not appear, click the refresh icon in the MailPoet tab.


It is also possible to use any form created in WS Form and add an action so that it is submitted to MailPoet when a user saves or submits their form.

To add a MailPoet action:

  1. When editing your form, click the Actions icon at the top of the page. The Actions sidebar will open on the right-hand side of the page.
  2. Click the Add  icon to add a new action.
  3. Select Add to a MailPoet List from the Action pulldown. A series of settings will appear.

As with all sidebars in WS Form, click the Save button at the bottom to save your changes, or click Cancel to disregard your changes.

The MailPoet action settings are as follows:

When Should This Action Run?

You can choose to run the MailPoet action when the form is saved, submitted, or both.

MailPoet List

Choose the MailPoet list you would like contacts to be added to. If you have created a new list since viewing this screen, you can click the refresh icon to retrieve the new list.


Select the method you would like to use when the form is submitted. Choose from:

  • Subscribe – This will add the contact and subscribe them to the selected MailPoet list
  • Unsubscribe – This will remove the contact from the selected MailPoet list
Field Mapping

Field mapping tells WS Form which of your form fields relate to the corresponding fields in MailPoet. For example you would want to map your Email field to the Email field in MailPoet.

To map a field:

  1. Click the Add  icon at the bottom right of the field mapping section.
  2. In the left-hand column, select your form field.
  3. In the right-hand column, select the corresponding MailPoet field.
  4. Repeat this process for each field on your form.
  5. Click the Save button at the bottom of the sidebar to save your changes.
Opt-In Field

Use this setting to select which of your fields to act as the opt-in field. We recommend adding a checkbox field with a single checkbox. It is always recommended that you have an unchecked, opt-in checkbox on your forms to ensure you comply with GDPR requirements.

Send Confirmation Email

If this is not checked, the sending of confirmation email will be disabled. It is strongly recommended to keep this setting checked so that MailPoet settings for sign-up confirmation are respected. Unchecking this setting might lead the subscriber being added as unconfirmed.

Schedule Welcome Email

If this is not checked, the sending of the welcome email will be disabled.

Skip Subscriber Notification

If this is not checked, the sending of the admin notification email will be disabled.

Populate Forms Using MailPoet

As well as pushing form data with this add-on, you can also retrieve contact data and populate the fields on your form.

This feature is only available if a website visitor is signed in and their WordPress email address matches the email address of a contact in MailPoet.

To enable this feature:

  1. Click the form settings icon in the top toolbar when editing a form.
  2. Click the Auto Populate tab in the sidebar on the right.
  3. Enable the Populate Using Action setting.
  4. Choose MailPoet from the Action To Populate From pull down.
  5. Select the list you wish to populate data from in the List To Populate From pull-down menu.
  6. Map the MailPoet fields to your form fields.
  7. Click Save at the bottom.

Note that if you created your form using a MailPoet template the field mappings will automatically be created for you.