Page Builder Summit Limited Time Offer - 20% OFF! Use coupon PBS20 - View Details


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

The iContact add-on lets you push new contacts using an action, pull contact data into WordPress using the WS Form PRO autocomplete feature, and create new forms from your lists in a single click on the add form page.

The iContact add-on requires WS Form PRO.


The iContact 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 iContact 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 iContact 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.

Connecting to iContact

In order to use the add-on, you need to obtain an API ID, username and password from iContact. It’s a simple process. If you do not have an iContact account, click here.

Obtaining an API ID, Username and Password

  1. Click on your name at the top right of the page, then click Settings and Billing.

iContact Settings and Billing

2. Click on iContact Integrations.

3. Click Create for Custom API Integrations.

iContact Create App

4. Complete the form using these suggested field values:

App Name: WS Form
App Description: WS Form iContact Add-On

5. Take a note of the API ID, Username and Password. Click Save Changes

Entering the API Email and Password

  1. Click WS Form in the WordPress administration menu.
  2. Click Settings.
  3. Click the iContact tab at the top of the page.
  4. Enter your API ID, username and password.
  5. Click the Save button.

Creating a Form for iContact


WS Form can create a form for any of our iContact 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 iContact form in WS Form:

  1. Click WS Form in the WordPress administration menu.
  2. Click Add New.
  3. Select the iContact tab at the top of the page.
  4. Click on any of your iContact 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 iContact tab.


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

To add a iContact 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 iContact 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 iContact action settings are as follows:

When Should This Action Run?

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

iContact List

Choose the iContact 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.

Contact Status

Select the contact status you would like new contacts added as. Choose from:

  • Normal
  • Bounced
  • Do not contact
  • Pending
  • Invitable
  • Deleted

Select the subscriber status you would like new contacts added as. Choose from:

  • Normal
  • Pending
  • Unsubscribed
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.

Field Mapping

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

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 iContact 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.

Populate Forms Using iContact

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 iContact.

To enable this feature:

  1. Click the Form Settings icon in the top toolbar when editing a form.
  2. Click the Data tab in the sidebar.
  3. Enable the Populate Using Action setting.
  4. Choose iContact 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 iContact fields to your form fields.
  7. Click Save at the bottom.

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