Campaign import export user docs by dcjarvis · Pull Request #361 · mautic/user-documentation

dcjarvis · 2025-05-09T10:42:29Z

Added descriptions for campaign import and campaign export.

dcjarvis · 2025-05-09T10:43:35Z

Note that these docs should be targeted to Mautic v7.x but that branch is not available yet.

passive -> active... hopefully

Co-authored-by: Ruth Cheesley <ruth@ruthcheesley.co.uk>

dcjarvis · 2025-05-22T11:46:23Z

Added further parameter to the command line for export

…nd_line_interface.rst

adiati98

@mautic/core-team @RCheesley,

As these are new pages, I deliberately took the initiative to adjust the wordings, restructure, and add images to make them clearer and consistent.

Therefore, I need your help to review the content thoroughly.

Additionally, I left some questions in this PR on the comments. TIA! ✨

adiati98 · 2026-03-05T11:10:05Z

@mautic/core-team @RCheesley,

As these are new pages, I deliberately took the initiative to adjust the wordings, restructure, and add images to make them clearer and consistent.

Therefore, I need your help to review the content thoroughly.

Additionally, I left some questions in this PR on the comments. TIA! ✨

@mautic/core-team any thoughts on this?

RCheesley

A few small suggestions!

RCheesley · 2026-03-11T11:34:47Z

+When you select a Campaign, the export feature extracts all Campaign data and entities, along with any dependencies the Campaign needs to function, including:
+
+* Dynamic Content
+* Asset\*


What does this asterisk indicate? I'd like us to include the reference if we're referring to something, right after these bullets.

RCheesley · 2026-03-11T11:36:01Z

+
+.. code-block:: bash
+
+   curl --location 'https://{your-mautic-domain}/api/campaigns/export/1' \


I wonder if we should make it explicit here that you replace everything in {your-mautic-domain} including the curly braces, or would that be obvious? Also we use that here, and example.com later. Why not use the same?

RCheesley · 2026-03-11T11:38:42Z

+
+#. Ensures inclusion of Campaign data, external Assets, and Dynamic Content.
+
+#. Select **Actions** option from the dropdown menu for the **Campaign** and **Segment** entities. Choose either **Update entity** or **Create new entity**.


I think we should explain what each does and why you see it - e.g. update entity suggests that it has found this already existing in Mautic, and it'll update with any changes compared to what's there (could be destructive, might overwrite changes). Create new will force it to create a new entity, even if something that matches is found. Safer option but can lead to duplication of resources.

RCheesley · 2026-03-11T11:40:15Z

+
+   |
+
+#. Click **Yes** when a prompt message appears.


We should link to the docs which explain what this means. Clicking yes can have consequences. Publishing a campaign without checking it first could also be disastrous. I think we need to add a clear warning here, that once you publish a campaign, it immediately starts running. People must check that they understand what the campaign is doing, and verify each step of the way, before they decide to turn it on. Red warning admonition called for, I think.

Copilot

Pull request overview

Adds end-user documentation for Campaign import/export and links it into the existing docs navigation and CLI command reference.

Changes:

Added new Campaign import and export documentation pages, including UI, CLI, and API usage.
Linked the new pages into the Campaigns section of the main docs index.
Updated the CLI command reference to include campaign import/export commands and improved the “bin/console” guidance.

Reviewed changes

Copilot reviewed 4 out of 13 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
docs/index.rst	Adds the new import/export pages to the Campaigns toctree for navigation.
docs/configuration/command_line_interface.rst	Updates CLI guidance and adds campaign import/export commands to the command list.
docs/campaigns/importing_campaigns.rst	New page documenting Campaign imports via UI, CLI, and API.
docs/campaigns/exporting_campaigns.rst	New page documenting Campaign exports via UI, CLI, and API.
docs/campaigns/images/upload_zip_file.png	Adds a screenshot used by the import docs.
docs/campaigns/images/campaign_active_toggle_button.png	Adds a screenshot used by the import docs.
.gitignore	Minor formatting/indent fix at EOF comment line.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-11T11:46:01Z

+
+.. vale off
+
+How the exporting Campaigns works


Section title grammar: How the exporting Campaigns works is ungrammatical and may read oddly in navigation/search. Consider renaming to something like How exporting Campaigns works or How Campaign export works for clarity and consistency.

Suggested change

How the exporting Campaigns works

How Campaign export works

Copilot · 2026-03-11T11:46:01Z

+
+.. vale off
+
+How the importing Campaign works


Section title grammar: How the importing Campaign works reads ungrammatical. Consider renaming to How importing Campaigns works or How Campaign import works to improve readability and consistency with the rest of the docs.

Suggested change

How the importing Campaign works

How Campaign import works

Copilot · 2026-03-11T11:46:02Z

+     - Imports Contacts from a CSV file
     - If the CSV import is configured to run in background then this command will pick up the pending import jobs and imports the data from CSV files to Mautic.


This list-table has 3 columns (Command / Description / Aliases), but the mautic:import row currently provides two description lines without an Aliases cell. In a reST list-table, each row must have the same number of cells; consider using a multi-line description within a single cell (e.g., | continuation) and keep the Aliases cell empty (-).

Suggested change

- Imports Contacts from a CSV file

- If the CSV import is configured to run in background then this command will pick up the pending import jobs and imports the data from CSV files to Mautic.

- | Imports Contacts from a CSV file

| If the CSV import is configured to run in background then this command will pick up the pending import jobs and imports the data from CSV files to Mautic.

-

Copilot · 2026-03-11T11:46:02Z

+* Dynamic Content
+* Asset\*
+* Other related dependencies
+


Asset\* includes an asterisk but there’s no corresponding footnote/explanation in this document. Either add the footnote text (e.g., explaining what’s included/excluded for Assets) or remove the asterisk to avoid confusing readers.

Suggested change

.. note::

The asterisk (*) indicates that only Assets directly associated with the exported Campaign are included.

Copilot · 2026-03-11T11:46:03Z

+   --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
+   --data ''


The cURL example uses --data '' with an export endpoint, but providing --data makes curl send a POST request (even if empty). Since this export endpoint is described as a GET, remove --data (or explicitly use --request GET) to avoid users making the wrong HTTP method call.

Suggested change

--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \

--data ''

--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Co-authored-by: Ruth Cheesley <ruth@ruthcheesley.co.uk> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

dcjarvis commented May 20, 2025

View reviewed changes

Comment thread docs/some-dir/README.md Outdated

dcjarvis commented May 20, 2025

View reviewed changes

Comment thread docs/some-dir/composer.json Outdated

dcjarvis and others added 21 commits May 22, 2025 12:27

Fri 2 May initial draft

ae60d10

Add .DS_Store to gitignore

3f908d9

Updated campaign import/export documentation

c6d5bd7

updates to user docs for campaign export and import

e57b5e2

clarify messenger:consume params

fbef5c6

Update cron_jobs.rst

b64cf46

Update cron_jobs.rst

bfa6d50

passive -> active... hopefully

Update cron_jobs.rst

c274d66

Update cron_jobs.rst

a044ec1

Update docs/configuration/cron_jobs.rst

bdb0fb9

Co-authored-by: Ruth Cheesley <ruth@ruthcheesley.co.uk>

Update docs/configuration/cron_jobs.rst

7ddbe75

updates from prose review

54669dd

updates from prose review

b50e7c9

updates from prose review 2

57b6f71

Resolve .gitignore merge conflict

1ff47f6

prose review 3

0ad90a0

prose review 4

1fc3e86

prose review 5

ef57099

prose review 6

2b81a5f

prose review complete

a911777

addition of path to export file command line parameter

4f4b529

dcjarvis force-pushed the campaign-import-export-user-docs branch from 5defae6 to 4f4b529 Compare May 22, 2025 11:32

RCheesley changed the base branch from 5.x to 7.0 May 22, 2025 12:18

RCheesley mentioned this pull request Jun 17, 2025

Campaign import/export process mautic/mautic#14504

Merged

adiati98 and others added 2 commits July 13, 2025 18:48

Merge branch '7.0' into campaign-import-export-user-docs

282ad9b

Merge branch '7.0' into campaign-import-export-user-docs

0ee96ce

adiati98 added 8 commits January 25, 2026 13:49

fix: unrendered table

c7fc039

adjust wordings and address Vale in exporting_campaigns.rst and comma…

6b1464b

…nd_line_interface.rst

adjust wordings and address vale warnings in importing_campaigns.rst

4b99b28

adjust wording and structure in exporting_campaigns.rst for consistency

c015187

apply vale off and on statements

ea8e73a

update instructions to export with mautic instance

a85a892

remove campaigns/images/activate-campaign.png

c2b1c2d

add images

51a7845

adiati98 reviewed Jan 25, 2026

View reviewed changes

adiati98 added 2 commits January 25, 2026 22:46

fix: broken internal links

dbebd0e

fix typo

3316507

adiati98 added this to Mautic's No/Low/Code Tasks Jan 25, 2026

adiati98 moved this to 🔎 In review in Mautic's No/Low/Code Tasks Jan 25, 2026

Merge branch '7.0' into campaign-import-export-user-docs

80c8590

adiati98 added 4 commits March 6, 2026 16:02

remove campaigns/images/campaign-sample.json

58f0c25

remove custom fields from supported data types

054bbc7

move how the exporting campaigns works section to the bottom

d1a7364

move How the importing Campaign works section to the bottom

5900ca5

adiati98 requested review from RCheesley, escopecz and vukovicpredrag March 6, 2026 15:31

RCheesley requested changes Mar 11, 2026

View reviewed changes

RCheesley requested review from Copilot and removed request for vukovicpredrag March 11, 2026 11:41

Copilot started reviewing on behalf of RCheesley March 11, 2026 11:42 View session

Copilot AI reviewed Mar 11, 2026

View reviewed changes

RCheesley and others added 3 commits April 1, 2026 16:01

Merge branch '7.0' into campaign-import-export-user-docs

ab58d10

Merge branch '7.0' into campaign-import-export-user-docs

0cd6665

Apply suggestions from code review

b8da6ff

Co-authored-by: Ruth Cheesley <ruth@ruthcheesley.co.uk> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>


		.. code-block:: bash

		curl --location 'https://{your-mautic-domain}/api/campaigns/export/1' \


		#. Ensures inclusion of Campaign data, external Assets, and Dynamic Content.

		#. Select Actions option from the dropdown menu for the Campaign and Segment entities. Choose either Update entity or Create new entity.

		- Imports Contacts from a CSV file
		- If the CSV import is configured to run in background then this command will pick up the pending import jobs and imports the data from CSV files to Mautic.



	.. note::

	The asterisk (*) indicates that only Assets directly associated with the exported Campaign are included.

		--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
		--data ''

Conversation

dcjarvis commented May 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dcjarvis commented May 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dcjarvis commented May 22, 2025

Uh oh!

adiati98 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

adiati98 commented Mar 5, 2026

Uh oh!

RCheesley left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

RCheesley Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

RCheesley Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

RCheesley Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

RCheesley Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

dcjarvis commented May 9, 2025 •

edited

Loading

dcjarvis commented May 9, 2025 •

edited

Loading