Skip to content

Commit 56aabae

Browse files
committed
prose review 5
1 parent 923a722 commit 56aabae

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

docs/campaigns/exporting_campaigns.rst

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -10,50 +10,50 @@ Before importing or exporting data, as a safety precaution take a backup of your
1010
.. important::
1111
Both the import and the export features are only available in Mautic 7.0 and later versions.
1212

13-
Supported Data Types
13+
Supported data types
1414
--------------------
1515

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:
1717

18-
- Dynamic content
18+
- Dynamic Content
1919
- Assets
2020
- Custom Fields
2121
- Other related dependencies
2222

2323
The export command will:
2424

25-
- Detect use of plugins and Custom Fields
25+
- Detect use of Plugins and Custom Fields
2626
- Include the data to support these dependencies
2727

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

31-
Export Mechanic
31+
Export mechanic
3232
***************
3333

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
3535
follows the same process.
3636
- Checks that the user has adequate permissions to export
37-
- Supports exporting multiple campaigns simultaneously
37+
- Supports exporting multiple Campaigns simultaneously
3838
- Exports data in a structured JSON format
3939
- Exports assets into a separate folder in their original format
4040
- Zips the resulting collection of files for easy transfer across systems
4141

42-
Export Methods
42+
Export methods
4343
**************
4444

4545
The export feature can be used in three ways:
4646

47-
**1. UI-Based Export**
47+
**1. UI-based export**
4848
----------------------
4949

5050
Manual export through Mautic Campaigns dashboard:
5151

5252
1. Go to the Campaigns menu
53-
2. Select the campaign you want to export
54-
3. Select the export option from the dropdown menu located next to the item selection
53+
2. Select the Campaign you want to Export
54+
3. Select the Export option from the dropdown menu located next to the item selection
5555

56-
**2. CLI-Based Export**
56+
**2. CLI-based export**
5757
-----------------------
5858

5959
Use the following commands:
@@ -62,22 +62,22 @@ Use the following commands:
6262
6363
bin/console mautic:entity:export --entity=campaign --id=1 --zip-file
6464
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
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
6868

6969
.. code-block:: bash
7070
7171
bin/console mautic:entity:export --entity=campaign --id=1 --json-file
7272
7373
* Creates only a JSON file and ignores any additional assets
7474

75-
**3. API-Based Export**
75+
**3. API-based export**
7676
-----------------------
7777

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>`_.
7979

80-
Curl Example
80+
Curl example
8181
************
8282

8383
.. code-block:: bash
@@ -86,7 +86,7 @@ Curl Example
8686
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
8787
--data ''
8888
89-
Python Example
89+
Python example
9090
**************
9191

9292
.. code-block:: python

0 commit comments

Comments
 (0)