Configuring One-Click Unsubscribe
Get the One-Click Unsubscribe widget up and running to help people unsubscribe from a publication or opt out of bulk emails.
See the Quick Start Guide to get started. If the shared script hasn't been added to your website, add it to the appropriate webpage, replacing "YOUR-BASE-MP-URL" with the base URL with your base MinistryPlatform URL.
<script id="MPWidgets" src="https://YOUR-BASE-MP-URL.com/widgets/dist/MPWidgets.js"></script>Create or identify a page on your website where you want to display the widget. To add this widget to your church website, add the code you generate in the Widget Configurator widget (with the required attributes) in the body of your chosen website page.
Widget Configuration
- Target URL
- The URL of the page where the My Subscriptions widget is on your website.Note: You must include the target URL for the My Subscriptions button to display in the widget. We recommend revising the Successful Bulk Email Opt-Out and Successful Unsubscribe Label application labels. The default text for both of these application labels is "My Subscriptions". See customization for more information.
- Attribute: mysubscriptionswidgettargeturl
- Valid Value: relative or fully qualified URL
- Examples:
mysubscriptionswidgettargeturl="/mysubscriptions/"mysubscriptionswidgettargeturl="https://example-church.com/mysubscriptions/"
Attributes must be included before the opening widget tag is closed. Attributes may be listed in any order and should be separated by a space or other whitespace. An attribute's value should be wrapped in quotation marks.
<mpp-unsubscribe mysubscriptionswidgettargeturl="https://example-church.com/mysubscriptions/"></mpp-unsubscribe>Configure Your Widget
- Go to your Widgets Library by appending "/widgets" to your system domain. For example,
https://example-church.ministryplatform.net/widgets. - Click the Navigate to... drop-down menu, and select Widget Configurator.
- Select the widget you want to configure, then customize your widget.
- Click Try it Out to see what your widget will look like!
- Copy the generated code from the Embed Code box.
- Add the code to the designated page on your website.
Link Configuration
The One-Click Unsubscribe widget needs URL parameters to work. Without them, it won't perform any actions. Specify the page for the widget in the URL, like "/unsubscribe". You can add these links to email footers or other places.
- [Contact_GUID]
- The contact merge field, so you can include the "Unsubscribe All" bulk email opt-out in any message or template sent from any MinistryPlatform page.
- [Publication_ID]
- You should only include this when the publication ID is a data field on a given MinistryPlatform page. For example, the All Subscriptions or the Subscribers tab on publications. You can also set it manually.
Bulk Email Opt-Out
https://yourchurch.com/unsubscribe?cg=[Contact_GUID]
Publication Unsubscribe
https://yourchurch.com/unsubscribe?cg=[Contact_GUID]&pubid=[Publication_ID]
Use these URLs anywhere, but it's best to create snippets for templates. Need help? A SPoC can contact Support.
Bulk Email Opt-Out Snippet
<a href="https://yourchurch.com/unsubscribe?cg=[Contact_GUID]">Bulk Email Opt-Out</a>
Publication Unsubscribe Snippet
<a href="https://yourchurch.com/unsubscribe?cg=[Contact_GUID]&pubid=[Publication_ID]">Unsubscribe</a>
Customization
You can customize any widget, so change the button color and update the labels to match your church. We suggest customizing your One-Click Unsubscribe widget to match your Subscribe to Publication and My Subscriptions widgets.
CSS: Every widget accepts the Custom CSS attribute. Include it before the closing of the opening widget tag to customize backgrounds, button colors, and more!
Application Labels: You can update the button text and more. To make changes, go to and update the appropriate label(s). Note that you are responsible for all translations if the default is not used.
- mpp-unsubscribe.mySubscriptionsButtonText: The My Subscriptions button text. The default is "My Subscriptions". Note: This button will not display if the optional attribute is not included.
- mpp-unsubscribe.successfulBulkEmailOptOut: The bulk opt-out confirmation message. The default is "You have been removed from bulk email. Didn't intend to opt-out? Undo or update your subscriptions preferences below. Thank you!"
- mpp-unsubscribe.successfulUnsubscribeLabel: The unsubscribe confirmation message. The default is "You have been unsubscribed. Didn't intend to unsubscribe? Undo or update your subscriptions preferences below. Thank you!"
- mpp-unsubscribe.unableToUnsubscribeError: The unable to unsubscribe error message. The default is "Unable to unsubscribe."