Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/channels/utm_tags.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,20 @@ Using UTM tags in Emails

Mautic supports UTM tagging in Emails. Mautic can automatically append UTM tags to all links in an Email by entering the appropriate Campaign values in the fields provided.

Setting global UTM defaults
Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Global UTM defaults section added based on PR #15905 which introduces site-wide default UTM values in Email configuration.

Source: mautic/mautic#15905

===========================

Configure default UTM values in **Configuration > Email Settings**. When you create a new Email, Mautic pre-populates the UTM fields with these defaults. This saves time if most of your Emails use similar tracking values.

.. note::

Default UTM tags only apply to new Emails. If you edit an existing Email or clone an Email, the original values remain unchanged.

For more details on configuring defaults, see :ref:`Default UTM tags <configuration/settings:Default UTM tags>`.

Setting UTM tags on individual Emails
=====================================

#. In Mautic, click Channels > Emails.
#. Create a new Email or edit an existing Email. If you choose to edit an existing Email, click the Email and then click Edit.
#. Locate the Google Analytics UTM tags section on the bottom right.
Expand Down
20 changes: 19 additions & 1 deletion docs/configuration/settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -398,14 +398,32 @@
* **Convert embed images to Base64** - Select **Yes** to display embedded images in Emails using embedded base64 code rather than as embedded images.

* **Disable trackable URLs** - Removes tracking from URLs in your Emails. Select Yes to prevent tracking, reporting on, and using decisions based on link clicks. Some Email service providers don't like redirecting URLs. Using trackable URLs in your Emails may impact deliverability.


Default UTM tags
----------------

Configure default UTM tags for new Emails. When you create a new Email, Mautic pre-populates the UTM fields with these defaults. Existing Emails, edited Emails, and cloned Emails retain their own UTM values.

* **Default UTM source** - The default value for the Campaign Source field. For example: ``newsletter``, ``website``.

* **Default UTM medium** - The default value for the Campaign Medium field. For example: ``email``, ``cpc``.

* **Default UTM campaign** - The default value for the Campaign Name field. For example: ``spring_sale``, ``product_launch``.

Check warning on line 411 in docs/configuration/settings.rst

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Campaign' instead of 'campaign'. Raw Output: {"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Campaign' instead of 'campaign'.", "location": {"path": "docs/configuration/settings.rst", "range": {"start": {"line": 411, "column": 17}}}, "severity": "INFO"}

* **Default UTM content** - The default value for the Campaign Content field. For example: ``header_link``, ``footer_link``.

.. note::
Default UTM tags only apply to new Emails. If you edit an existing Email or clone an Email, the original values remain unchanged - even if those values are empty.

Unsubscribe settings
====================

.. image:: images/unsubscribe-settings.png
:width: 600
:alt: Screenshot showing Unsubscribe Settings Configuration in Mautic

* **Default Preference Center** - Select a default Preference Center page for new Emails. When you create a new Email, Mautic pre-populates the Preference Center field with this selection. Existing Emails, edited Emails, and cloned Emails retain their own Preference Center selection. For more information on creating Preference Center pages, see the :doc:`Preference Center documentation</contacts/preference_center>`.

Check warning on line 425 in docs/configuration/settings.rst

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Contacts' instead of 'contacts'. Raw Output: {"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Contacts' instead of 'contacts'.", "location": {"path": "docs/configuration/settings.rst", "range": {"start": {"line": 425, "column": 391}}}, "severity": "INFO"}

Check warning on line 425 in docs/configuration/settings.rst

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Landing Pages' instead of 'pages'. Raw Output: {"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Landing Pages' instead of 'pages'.", "location": {"path": "docs/configuration/settings.rst", "range": {"start": {"line": 425, "column": 337}}}, "severity": "INFO"}

Check warning on line 425 in docs/configuration/settings.rst

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Landing Page' instead of 'page'. Raw Output: {"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Landing Page' instead of 'page'.", "location": {"path": "docs/configuration/settings.rst", "range": {"start": {"line": 425, "column": 70}}}, "severity": "INFO"}

* **Text for the {unsubscribe_text} token** - Like the ``{webview_text}`` token, this allows you to customize the **Unsubscribe** link.

For example - Edit between the ``<a href="|URL|">`` and ``</a>`` tags. Don't change the URL as it's tokenized. If you add ``{unsubscribe_url}`` as a token in the Email, you won't see this text.
Expand Down
4 changes: 4 additions & 0 deletions docs/contacts/preference_center.rst
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,10 @@

|

.. tip::
Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tip about default Preference Center added based on PR #15905 which allows setting a site-wide default Preference Center page.

Source: mautic/mautic#15905


You can set a default Preference Center in **Configuration > Email Settings**. When you create a new Email, Mautic pre-populates the Preference Center field with this default selection. This saves time if most of your Emails use the same Preference Center page. For details, see :ref:`Unsubscribe settings <configuration/settings:Unsubscribe settings>`.

Check warning on line 184 in docs/contacts/preference_center.rst

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Landing Page' instead of 'page'. Raw Output: {"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Landing Page' instead of 'page'.", "location": {"path": "docs/contacts/preference_center.rst", "range": {"start": {"line": 184, "column": 260}}}, "severity": "INFO"}

Keep in mind that your mail must use the same language as the Preference Center landing page - if not, Mautic shows the default Preference Center.

Now when sending the Email, all recipients can click the Unsubscribe link provided in the ``{unsubscribe_text}`` and ``{unsubscribe_url}`` variables, taking them to the new Preference Center.
Expand Down
Loading