Opt-out Settings

The email opt-out settings page lets you customize the messages displayed to users who unsubscribe from your email communications. You can modify the unsubscribe prompt text and the confirmation message shown after they successfully unsubscribe.

To access and configure the email opt-out settings, follow these steps:

Step 1: Navigate to the Opt-out Settings Section

  1. In the main menu on the left, go to Email > Opt-out Settings.

  2. Click the Edit button.

../../../_images/fig1613.png

Fig. 1. Opt-out Settings and Edit Button.

Step 2: Edit Opt-out Message Settings

On the Email Opt-Out Settings page, you can enter values for the following fields:

Email Opt-out Settings Fields

Field

Description

Form Header

This is the title displayed at the top of the opt-out form shown to users. By default, it is set to “Unsubscribe.”

Form Body

The message asking users if they want to unsubscribe. This field supports placeholders, allowing you to personalize the message.

For example, use:

  • {{masked_email}} to show the recipient’s masked email address.

  • {{brand_name}} to show the brand name.

Example: “Do you want to unsubscribe the email address {{masked_email}} from Email messages coming from {{brand_name}}?”

Form Action

The text on the action button that users select to confirm their unsubscription. By default, it is set to “Yes, unsubscribe.”

Success Header

The title displayed on the success page after the user has successfully unsubscribed. Default text is “Unsubscribed.”

Success Body

The confirmation message shown to users after they successfully unsubscribe. Default is “Unsubscribed successfully.”

../../../_images/fig1712.png

Fig. 3. Edit Email Opt-out settings.

Step 3: Use Placeholders for Personalization

In the left pane, you’ll find available Workspace Placeholders and Contact Placeholders that can be inserted into the form messages to enhance personalization. Below is a comprehensive list of placeholders you can use:

Available Placeholders

Placeholder

Description

Workspace Placeholders

{{brand_name}}

Inserts the name of your brand.

{{company_address}}

Inserts your company address.

Contact Placeholders

{{masked_phone_number}}

Inserts the masked version of the contact’s phone number.

{{masked_email}}

Inserts the masked version of the recipient’s email.

{{contact.messaging_id}}

Inserts the unique messaging ID associated with the contact.

{{contact.contact_id}}

Inserts the contact’s unique ID in the system.

{{contact.first_name}}

Inserts the contact’s first name.

{{contact.last_name}}

Inserts the contact’s last name.

{{contact.full_name}}

Inserts the contact’s full name (first and last name combined).

{{contact.phone_number}}

Inserts the contact’s full phone number.

{{contact.email}}

Inserts the contact’s full email address.

{{contact.timezone}}

Inserts the contact’s time zone.

To insert a placeholder, click on the placeholder from the list in the left pane, and it will automatically be added to the selected field in the form. This feature allows you to personalize the opt-out prompt and success message.

../../../_images/fig1812.png

Fig. 4. Workspace and Contact Placeholders.

Step 4: Preview the Opt-out Form and Success Page

The right side of the page includes a live preview area that shows how the opt-out form and success page will appear on a mobile device. You can switch between the Opt-out form and Success page tabs to preview each screen.

  • Opt-out form: Displays the unsubscribe prompt as it will appear to recipients.

  • Success page: Shows the confirmation page that appears after a successful unsubscribe action.

Use this preview feature to verify that your customized messages appear as expected.

../../../_images/fig1910.png

Fig. 5. Opt-out form and Success page.

Step 5: Submit Your Changes

After customizing the fields, click Submit to save your changes.

../../../_images/fig204.png

Fig. 6. Submit Button.

Note

Use placeholders such as {{masked_email}} and {{brand_name}} to create a clear and personalized opt-out experience. This helps users understand who is sending the emails and what they are unsubscribing from.