Quick Start

Allow your Contacts to unsubscribe from a single publication or opt out of bulk email with the One-Click Unsubscribe Widget. See the Quick Start Guide for tips on getting the One-Click Unsubscribe Widget up and running.

If the shared script hasn't been added to your website, add it to your desired webpage. Be sure to replace "{your church website}" in the following code with your church's website URL.

<script id="MPWidgets" src="https://{your church website}/widgets/dist/MPWidgets.js"></script>

Create a webpage on your website that will display your One-Click Unsubscribe Widget or identify the page on your website where it will be displayed.

Add the One-Click Unsubscribe Widget to your church website by adding the following snippet of code, along with required attributes, in the body of your chosen website page, modifying the required attributes discussed below.

<mpp-unsubscribe></mpp-unsubscribe>

Widget Configuration

The One-Click Unsubscribe Widget functions without any additional attributes, but you can add an optional attribute. If you choose not to include the My Subscriptions Target URL attribute, the "My Subscriptions" button will not appear in the Widget and we recommend revising the Successful Bulk Email Opt-Out and Successful Unsubscribe Label application labels. The default text for both of these application labels references My Subscriptions. See Customization below for more information.

• My Subscriptions Target URL: Identifies the URL where the My Subscriptions Widget is configured.
  • Attribute: mysubscriptionswidgettargeturl
  • Valid Values: relative or fully qualified URL

mysubscriptionswidgettargeturl="/mysubscriptions/"

mysubscriptionswidgettargeturl="https://ministryplatform.com/mysubscriptions/"

All 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). Each attribute's value should be wrapped in quote marks.

<mpp-unsubscribe mysubscriptionswidgettargeturl="/mysubscriptions/"></mpp-unsubscribe>

<mpp-unsubscribe mysubscriptionswidgettargeturl="https://ministryplatform.com/mysubscriptions/"></mpp-unsubscribe>

Configure your Widget!

Link Configuration

The One-Click Unsubscribe Widget expects and relies on URL parameters. Navigating directly to this Widget without URL parameters will present no actions. Whichever page the One-Click Unsubscribe Widget is configured on should be specified in the URL. In our examples, we used "/unsubscribe" as the designated page. The links can be constructed and included in email footers or anywhere else your heart desires. Note: The URLs include tokens, so if you're sending them in an email, pay attention to which Platform page the email is being sent from.

• The [Contact_GUID] token is a Contact Merge Field, so "Unsubscribe All" (bulk email opt-out) can be included in any Message or Template sent from any Platform Page.
• The [Publication_ID] token should only be included when Publication ID is a Data Field on a given Platform Page (for example, All Subscriptions or the Subscribers tab on Publications). Alternatively, it can be manually set.

Bulk Email Opt-Out

https://{your church domain}/unsubscribe?cg=[Contact_GUID]

Publication Unsubscribe

https://{your church domain}/unsubscribe?cg=[Contact_GUID]&pubid=[Publication_ID]

While you can use these URLs anywhere, we strongly recommend creating snippets and including the appropriate snippet at the bottom of various templates used for publications or bulk emails. Want help setting up your snippet? Support is just a chat away!

Bulk Email Opt-Out Snippet

<a href="https://{your church domain}/unsubscribe?cg=[Contact_GUID]">Bulk Email Opt-Out</a>

Publication Unsubscribe Snippet

<a href="https://{your church domain}/unsubscribe?cg=[Contact_GUID]&pubid=[Publication_ID]">Unsubscribe</a>

Customization

All Widgets are customizable, so change the button color and update the labels to match YOUR church!  May 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 opening Widget tag is closed to customize your Widgets. 

Application Labels: You can update the button text (and more)! Navigate to System Setup > Application Labels (note that churches are responsible for all translations if the default is not used) and make your update.

• mpp-unsubscribe.mySubscriptionsButtonText - My Subscriptions button text. Default is "My Subscriptions." Note: This button will not appear if the optional attribute is not included.
• mpp-unsubscribe.successfulBulkEmailOptOut - Bulk opt-out confirmation. 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 - Unsubscribe confirmation. Default is "You have been unsubscribed. Didn’t intend to unsubscribe? Undo or update your subscriptions preferences below. Thank you!"
• mpp-unsubscribe.unableToUnsubscribeError - Unable to unsubscribe error message. Default is "Unable to unsubscribe."