You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/campaigns/exporting_campaigns.rst
+20-20Lines changed: 20 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,50 +10,50 @@ Before importing or exporting data, as a safety precaution take a backup of your
10
10
.. important::
11
11
Both the import and the export features are only available in Mautic 7.0 and later versions.
12
12
13
-
Supported Data Types
13
+
Supported data types
14
14
--------------------
15
15
16
-
Once a campaign is selected, the export feature will extract all campaign data and entities and any dependencies that the campaign needs to function. This includes:
16
+
Once a Campaign is selected, the export feature will extract all Campaign data and entities and any dependencies that the Campaign needs to function. This includes:
17
17
18
-
- Dynamic content
18
+
- Dynamic Content
19
19
- Assets
20
20
- Custom Fields
21
21
- Other related dependencies
22
22
23
23
The export command will:
24
24
25
-
- Detect use of plugins and Custom Fields
25
+
- Detect use of Plugins and Custom Fields
26
26
- Include the data to support these dependencies
27
27
28
28
.. important::
29
-
The importing instance will need the same Custom Fields and plugins to be present.
29
+
The importing instance will need the same Custom Fields and Plugins to be present.
30
30
31
-
Export Mechanic
31
+
Export mechanic
32
32
***************
33
33
34
-
Whether exporting via the UI, the command line or using the API, the export feature
34
+
Whether exporting via the UI, the command line or using the API, the Export feature
35
35
follows the same process.
36
36
- Checks that the user has adequate permissions to export
* `entity` defines the type of entity to export, in this case `campaign`
66
-
* `id` defines the id of the campaign to export. Look at the URL to find the ID when you view or edit the campaign - the ID will appear in the URL for example, /s/campaigns/view/123 where 123 is the ID
67
-
* `zip-file` creates a zip file of the campaign and its dependencies
65
+
* `entity` defines the type of entity to Export, in this case `campaign`
66
+
* `id` defines the id of the Campaign to Export. Look at the URL to find the ID when you view or edit the Campaign - the ID will appear in the URL for example, /s/campaigns/view/123 where 123 is the ID
67
+
* `zip-file` creates a zip file of the Campaign and its dependencies
* Creates only a JSON file and ignores any additional assets
74
74
75
-
**3. API-Based Export**
75
+
**3. API-based export**
76
76
-----------------------
77
77
78
-
You can export campaigns programmatically using the Mautic API. You will need to authenticate for the API request. using the API credentials stored in Mautic's settings. For more detail on how to authenticate, see the `Mautic API documentation <https://docs.mautic.org/en/5.x/authentication/authentication.html>`_.
78
+
You can export Campaigns programmatically using the Mautic API. You will need to authenticate for the API request. using the API credentials stored in Mautic's settings. For more detail on how to authenticate, see the `Mautic API documentation <https://docs.mautic.org/en/5.x/authentication/authentication.html>`_.
0 commit comments