Skip to content

docs: Document global defaults for Preference Center and UTM tracking#698

Closed
promptless-for-oss wants to merge 2 commits into
mautic:7.1from
Promptless:promptless/email-global-defaults
Closed

docs: Document global defaults for Preference Center and UTM tracking#698
promptless-for-oss wants to merge 2 commits into
mautic:7.1from
Promptless:promptless/email-global-defaults

Conversation

@promptless-for-oss
Copy link
Copy Markdown

Open this suggestion in Promptless to view citations and reasoning process

Documents the new Email configuration settings introduced in PR #15905 that allow admins to configure site-wide defaults for Preference Center and UTM tracking parameters.

Changes

configuration/settings.rst

  • New "Default UTM tags" subsection in Message settings documenting the four default UTM fields (source, medium, campaign, content)
  • New "Default Preference Center" setting in Unsubscribe settings section
  • Notes explaining that defaults only apply to new Emails; existing, edited, and cloned Emails retain their own values

channels/utm_tags.rst

  • New "Setting global UTM defaults" section explaining how to configure default UTM values in Configuration > Email Settings
  • Cross-reference to the detailed settings documentation

contacts/preference_center.rst

  • Added tip about configuring a default Preference Center in Email settings
  • Cross-reference to the Unsubscribe settings documentation

Tip: Create additional Docs Collections to keep multiple repositories in sync 📚


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


|

.. 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

@adiati98
Copy link
Copy Markdown
Contributor

@promptless-for-oss please rebase to branch 7.1

@adiati98 adiati98 changed the base branch from 7.1 to 7.0 April 22, 2026 08:54
@adiati98 adiati98 changed the base branch from 7.0 to 7.1 April 22, 2026 08:54
@adiati98
Copy link
Copy Markdown
Contributor

@promptless-for-oss please rebase to 7.1

Copy link
Copy Markdown
Contributor

@adiati98 adiati98 left a comment

Choose a reason for hiding this comment

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

@promptless-for-oss please address the suggestions.

Comment thread .github/styles/config/vocabularies/Mautic/accept.txt Outdated
Comment thread docs/channels/utm_tags.rst Outdated
Comment thread docs/channels/utm_tags.rst Outdated
Comment thread docs/contacts/preference_center.rst Outdated
Comment thread docs/channels/utm_tags.rst Outdated
@adiati98 adiati98 marked this pull request as ready for review April 23, 2026 18:52
@adiati98 adiati98 requested a review from a team as a code owner April 23, 2026 18:52
@adiati98 adiati98 requested review from adiati98 and favour-chibueze and removed request for a team April 23, 2026 18:52
@adiati98
Copy link
Copy Markdown
Contributor

@promptless-for-oss please rebase to 7.1

@adiati98
Copy link
Copy Markdown
Contributor

@promptless-for-oss please address the suggestions.

@promptless-for-oss
Copy link
Copy Markdown
Author

I've addressed all 5 review suggestions:

  1. ✅ Removed unused word from vocabulary file
  2. ✅ Bolded navigation paths for consistency
  3. ✅ Fixed note directive formatting (blank line + indentation)
  4. ✅ Fixed tip directive formatting (blank line + indentation)
  5. ✅ Fixed cross-reference syntax

The changes have been pushed to this branch. Please let me know if anything else needs adjustment!

@adiati98
Copy link
Copy Markdown
Contributor

@promptless-for-oss please rebase to 7.1.

promptless Bot added 2 commits April 29, 2026 20:51
Add documentation for new Email configuration settings that allow admins
to set site-wide defaults for:
- Default Preference Center page
- Default UTM source, medium, campaign, and content

These defaults are automatically pre-populated when creating new Emails.
Existing, edited, and cloned Emails retain their own values.

Related to mautic/mautic#15905
- Remove unused 'rebase' word from vocabulary accept list
- Bold navigation paths for consistency (Configuration > Email Settings)
- Fix RST admonition formatting: add blank lines and 3-space indentation
- Add space before angle bracket in :ref: cross-references
@promptless-for-oss promptless-for-oss force-pushed the promptless/email-global-defaults branch from c946eaa to a051aaa Compare April 29, 2026 20:51
@promptless-for-oss
Copy link
Copy Markdown
Author

Rebased onto the latest 7.1 branch. The branch now contains only the 2 commits specific to this documentation update:

  1. 314b4c8 - Document global defaults for preference center and UTM tracking
  2. a051aaa - Address PR review feedback

The messy merge history has been cleaned up.

Copy link
Copy Markdown
Contributor

@adiati98 adiati98 left a comment

Choose a reason for hiding this comment

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

@promptless-for-oss please address the suggestions

Comment on lines +407 to +411
* **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``.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
* **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``.
* **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``.


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

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

Choose a reason for hiding this comment

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

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

Comment on lines +415 to +416
.. 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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
.. 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.
.. 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.

@adiati98
Copy link
Copy Markdown
Contributor

@promptless-for-oss this PR has been addressed in #670. So, I'll close this.

@adiati98 adiati98 closed this May 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants