GF MailChimp Unsubscriber

A WordPress plugin that extends Gravity Forms to automatically unsubscribe, archive, or permanently delete contacts from MailChimp audiences when a form is submitted — based on checkbox selections.

Requirements

• WordPress 5.8+
• PHP 7.4+
• Gravity Forms (active)
• Gravity Forms MailChimp Add-On (active and connected)

Installation

From GitHub

1. Download the latest release or clone the repository:

   cd wp-content/plugins/
   git clone https://github.com/dompl/gf-mailchimp-unsubscriber.git

2. Activate the plugin in Plugins > Installed Plugins.
3. Navigate to Forms > MailChimp Unsubscriber to configure.

Manual Upload

1. Download the ZIP from GitHub.
2. In WordPress, go to Plugins > Add New > Upload Plugin and upload the ZIP.
3. Activate and configure under Forms > MailChimp Unsubscriber.

Features

Checkbox-Based Triggers

The plugin scans all Gravity Forms for checkbox fields and lets you designate individual choices as unsubscribe triggers. Enable any checkbox choice and configure when it should fire — when the checkbox is checked or unchecked.

MailChimp Actions

Three actions are available per rule:

Flexible Email Field Selection

Choose which form field contains the subscriber's email address. Supports both dedicated Email fields and plain Text inputs.

MailChimp Audience Selection

Target specific MailChimp audiences or apply the action to all audiences in the account. Audience lists are fetched live from the MailChimp API.

Automatic Verification & Retry

After sending the removal request, the plugin verifies the action was successful via the MailChimp API. If not confirmed, it retries automatically before flagging a failure.

Failure Notification Emails

When an unsubscribe cannot be confirmed after retrying, a customisable notification email is sent. Configure:

• Recipients — one or more comma-separated email addresses.
• Subject & body — fully editable with {{email}}, {{list_id}}, {{form_id}}, and {{form_name}} placeholders.

Confirmation Merge Tag

Use {gfmcu_message} in any Gravity Forms confirmation or notification to display a contextual message:

• Success — e.g. "You have been successfully unsubscribed from the mailing list."
• Failure — e.g. "There was a problem unsubscribing. Please contact us."

Both messages are editable in the settings. Results are persisted to entry meta so the merge tag works in both synchronous and asynchronous notification processing.

Configuration

All settings are managed from a single page at Forms > MailChimp Unsubscriber:

1. Enable a checkbox choice by ticking it.
2. Set the condition — trigger on checked or unchecked.
3. Choose the MailChimp action — unsubscribe, archive, or delete.
4. Select the email field — which field holds the subscriber's email.
5. Pick audiences — all lists or specific ones.
6. Configure notifications — failure email recipients, subject, body.
7. Set confirmation messages — success and failure text for {gfmcu_message}.
8. Click Save All Settings.

How It Works

1. A visitor submits a Gravity Form.
2. The GF MailChimp Add-On processes its subscription feeds first (priority 10).
3. This plugin evaluates its rules (priority 20) — no interference with subscriptions.
4. If a rule triggers, the plugin calls the MailChimp API to remove the contact.
5. The removal is verified; if unconfirmed, it retries once.
6. On confirmed failure, a notification email is sent to the configured recipients.
7. The {gfmcu_message} merge tag resolves to the appropriate message in confirmations and notifications.

API Credentials

No separate API configuration is needed. The plugin reads credentials directly from the Gravity Forms MailChimp Add-On settings (supports both OAuth2 and legacy API key authentication).

License

GPL-2.0+