diff --git a/docs/plugins/mailchimp.rst b/docs/plugins/mailchimp.rst index d539f881..867e21f2 100644 --- a/docs/plugins/mailchimp.rst +++ b/docs/plugins/mailchimp.rst @@ -3,8 +3,7 @@ MailChimp ######### -.. vale on -This plugin can send contacts to MailChimp cilents based on Contact actions or Point Triggers. +This Plugin can send Contacts to MailChimp lists based on Contact actions or Point Triggers. Authorize ********* @@ -17,17 +16,17 @@ Authorize 2. Go to *Account* / *Extras* / *API Keys* and create a new one. 3. Copy the created API Key. -.. image:: plugins-mailchimp-create-api-key-1-and-2.png - :alt: Screenshot of MailChimp dashboard with arrows pointing at the Extras tab and the API Keys section - :align: center - - .. image:: plugins-mailchimp-create-api-key-3a.png - :alt: Screenshot of MailChimp dashboard with an arrow pointing at the Create API Key button + .. image:: images/plugins-mailchimp-create-api-key-1-and-2.png + :alt: Screenshot of MailChimp dashboard with arrows pointing at the Extras tab and the API Keys section :align: center - .. image:: plugins-mailchimp-create-api-key-3b-and-3c.png - :alt: Screenshot of the Name New API Key section with arrows pointing at the test and Generate Key button - :align: center + .. image:: images/plugins-mailchimp-create-api-key-3a.png + :alt: Screenshot of MailChimp dashboard with an arrow pointing at the Create API Key button + :align: center + + .. image:: images/plugins-mailchimp-create-api-key-3b-and-3c.png + :alt: Screenshot of the Name New API Key section with arrows pointing at the test and Generate Key button + :align: center Authorize Mautic - MailChimp plugin =========== @@ -36,15 +35,21 @@ Authorize 2. Add the **API key** 3. Click on ***Save & Close*** +.. vale off - -Configure the plugin +Configure the Plugin ********** +.. vale on + +Navigate to the *Features* tab in the Plugin configuration modal box. You should see this note: -Navigate to the *Features* tab in the plugin configuration modal box. You should see this note: +.. vale off -> The Contact Field Mapping tab will appear after selecting a segment and will update after changing the selected segment. +.. note:: + The Contact Field Mapping tab will appear after selecting a segment and will update after changing the selected segment. + + .. vale on .. image:: plugins-mailchimp-configure.png :alt: MailChimp Plugin configuration @@ -52,21 +57,24 @@ Navigate to the *Features* tab in the plugin configuration modal box. You should 1. Select the Segment. - If you don't have a segment in `MailChimp`_ created yet, go to *MailChimp dashboard* / *Segments* / *Create List* and create one. + If you don't have a Segment in MailChimp created yet, go to *MailChimp dashboard* / *Segments* / *Create List* and create one. -2. Save the plugin configuration +2. Save the Plugin configuration 3. Open it again. The *Contact Field Mapping* tab should appear now. 4. Configure the `field mapping`_. + Other configuration options =========== +.. vale off +- **Push Contacts to this Integration** -- **Push contacts to this integration** +.. vale on - The options described below are turned on by default. If you leave them off, the plugin will not push contacts to MailChimp. +Mautic enables these options by default. If you leave them off, the Plugin won't push Contacts to MailChimp. -- **Enable double opt in** - If MailChimp should send a confirmation email to the contacts added by this plugin. The contacts will have to confirm that they really want to be added to the segment. -- **Send welcome email** - Whether MailChimp should send the welcome email. \ No newline at end of file +- **Enable double opt in** - If MailChimp should send a confirmation Email to the Contacts added by this Plugin. The Contacts must confirm that they really want to join the Segment. +- **Send welcome Email** - Whether MailChimp should send the welcome Email. \ No newline at end of file