> For the complete documentation index, see [llms.txt](https://docs.growsurf.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.growsurf.com/integrations/mailchimp.md).

# Mailchimp

Update Mailchimp contacts with their unique share link and referrer information.

## Sync with your Mailchimp Audience

**Step 1:** In *Program Editor > 4. Options > Integrations*, click the *Connect to Mailchimp* button.

{% hint style="info" %}
Connect Mailchimp before importing participants. If participants are already in your program, follow [these ESP sync options](https://support.growsurf.com/article/385-how-can-i-sync-my-growsurf-participants-to-my-esp) to send their GrowSurf data to Mailchimp.
{% endhint %}

![](https://2794996218-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LeklWo0yn03AhWro2Ux%2F-MFE2S6gaDpolokOz6fS%2F-MFE5zNiWd3Zurf_2O4B%2FScreen%20Shot%20on%202020-08-20%20at%2022%3A25%3A47.png?alt=media\&token=ddf71f5a-3c8c-461f-aa36-d686be9ba954)

**Step 2:** Log in to Mailchimp

![](https://2794996218-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LeklWo0yn03AhWro2Ux%2F-MFE2S6gaDpolokOz6fS%2F-MFE6DhB5Hr2nCFrfdMu%2FScreen%20Shot%20on%202020-08-20%20at%2022%3A23%3A23.png?alt=media\&token=cf67c4ca-efa4-4c0d-9b07-20299bf0083d)

**Step 3:** Once connected, choose the Mailchimp Audience that you want to automatically sync to. GrowSurf will add/update your Mailchimp contacts every time a new participant is added or referred to your referral or affiliate program.

## Examples

[View our Mailchimp tutorials](https://docs.growsurf.com/additional-integrations/mailchimp/tutorials) to see different kinds of examples that you can copy/paste into your email templates.

## Merge Tags

GrowSurf will automatically create these new `*|MERGE|*` tags for your Mailchimp Audience.

{% hint style="danger" %}
Mailchimp has a max limit on the number of merge fields that are allowed per audience/list. Typical Mailchimp accounts have a limit of 30 merge fields per list. Pro accounts have a limit of 80.\
\
If some merge fields are missing, your list has hit this limit. Delete unused merge fields in Mailchimp to make room.
{% endhint %}

| **\*\|MERGE\|\* tag** | **Field Label**                          | **Type** | **Description**                                                                                                                                                                                  | **Example**                                                |
| --------------------- | ---------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------- |
| `*\|SHAREURL\|*`      | GrowSurf Share URL                       | url      | The participant's unique referral link                                                                                                                                                           | <https://piedpiper.com?grsf=d8a1wa>                        |
| `*\|GROWSURFID\|*`    | GrowSurf Participant ID                  | text     | The participant's unique GrowSurf ID                                                                                                                                                             | d8a1wa                                                     |
| `*\|REFSTATUS\|*`     | GrowSurf Referral Status                 | text     | The referral status of the participant\*                                                                                                                                                         | CREDIT\_PENDING                                            |
| `*\|REFFNAME\|*`      | GrowSurf Referrer First Name             | text     | The first name of the participant's referrer (if applicable)                                                                                                                                     | Gavin                                                      |
| `*\|REFLNAME\|*`      | GrowSurf Referrer Last Name              | text     | The last name of the participant's referrer (if applicable)                                                                                                                                      | Belson                                                     |
| `*\|REFEMAIL\|*`      | GrowSurf Referrer Email                  | text     | The email address of the participant's referrer (if applicable)                                                                                                                                  | <gavin@hooli.com>                                          |
| `*\|TREFCOUNT\|*`     | GrowSurf Total Referral Count            | number   | The participant's all-time referral count                                                                                                                                                        | 0                                                          |
| `*\|LEADCOUNT\|*`     | GrowSurf Lead Count                      | number   | The participant's current lead count (pending referrals that have not converted yet)                                                                                                             | 0                                                          |
| `*\|MREFCOUNT\|*`     | GrowSurf Monthly Referral Count          | number   | The participant's current month referral count                                                                                                                                                   | 19                                                         |
| `*\|PMREFCOUNT\|*`    | GrowSurf Previous Monthly Referral Count | number   | The participant's previous month referral count                                                                                                                                                  | 200                                                        |
| `*\|NXTREWARD\|*`     | GrowSurf Next Milestone                  | text     | The text for the next/upcoming milestone reward (Only applies to milestone awards. [See an example here](https://docs.growsurf.com/developer-tools/embeddable-elements#embedded-next-milestone)) | You are only 2 referrals away from winning a free t-shirt! |
| `*\|NXTMREWARD\|*`    | GrowSurf Next Monthly Milestone          | text     | The text for the next/upcoming milestone reward (Only applies to milestone awards[.See an example here](https://docs.growsurf.com/developer-tools/embeddable-elements#embedded-next-milestone))  | You are only 2 referrals away from winning a free t-shirt! |
| `*\|INVCOUNT\|*`      | GrowSurf Total Invite Count              | number   | The participant's all-time invite count                                                                                                                                                          | 11                                                         |
| `*\|IMPCOUNT\|*`      | GrowSurf Total Impression Count          | number   | The participant's all-time impression count                                                                                                                                                      | 150                                                        |

\*\**|REFSTATUS|\** can have one of these values:

* `CREDIT_PENDING`: The participant must trigger a referral before their referrer receives credit.
* `CREDIT_AWARDED`: The participant triggered a referral, and their referrer received credit.
* `CREDIT_EXPIRED`: The participant did not trigger a referral before the referral credit expired.

You can use these `*|MERGE|*` tags in your Mailchimp email templates. For example, use `*|SHAREURL|*` to add each participant's unique referral link.

[Learn more about Mailchimp merge tags here.](https://mailchimp.com/help/getting-started-with-merge-tags/)

## Troubleshooting Tips

* **If the new participant isn't being added to Mailchimp, or if they are being added but their unique referral link isn't being synced to Mailchimp:**
  * Check the participant's activity logs. GrowSurf retries failed syncs for up to 7 days.
  * Some failures are fatal to Mailchimp and cannot be re-attempted. One example is the '*Forgotten Email Not Subscribed*' error, which means that the Mailchimp contact was permanently deleted from the Mailchimp Audience and so you must manually re-add them.
  * Make sure your program's Share URL is a valid URL, such as `https://yoursite.com`. An invalid URL such as `https://thiswontwork` will result in the new participant not being saved to Mailchimp.
  * If the participant email contains a `+` symbol within the email, Mailchimp will only allow a certain number of these emails into a list before it errors with a message such as `gavin+duplicate@hooli.com has signed up to a lot of lists very recently; we\'re not allowing more signups for now`
  * If your Mailchimp Audience requires specific merge fields (e.g, `FNAME`, `LNAME`), but your newly added GrowSurf participant isn't sending those merge fields to Mailchimp, then Mailchimp will reject the new contact from being added. This could happen if you had initially connected GrowSurf to Mailchimp, but you later made one or more Mailchimp merge fields in your Audience required. To fix this, you must uncheck the required field(s).
    * Depending on your last contact synced, in your GrowSurf Program Editor, you may see a "Your merge fields were invalid...Please enter a value" error message ([see image](https://blobscdn.gitbook.com/v0/b/gitbook-28427.appspot.com/o/assets%2F-LeklWo0yn03AhWro2Ux%2F-LqwuTn5n9Z_Zqmg3OXH%2F-LqwyOGQIpF8eOmCuevC%2FScreen%20Shot%202019-10-11%20at%205.29.31%20PM.png?alt=media\&token=b5e38819-9779-4e0f-a614-d52ef8089bef)), which means that GrowSurf has tried to save a new participant to Mailchimp, but could not due to a missing merge field value.
    * For further help, see [*Mailchimp Help - Set Default Merge Values for an Audience*](https://mailchimp.com/help/set-default-merge-values/)
  * If a merge field contains a `null` value, validation fails and Mailchimp does not add or update the contact. Merge field values should be strings, or empty strings at the bare minimum.
* **If you have** [***Final Welcome Email***](https://mailchimp.com/help/enable-or-disable-final-welcome-email/) **enabled in Mailchimp, but you are not seeing the email sent to new Mailchimp contacts:**
  * The *Final Welcome Email* will not be sent out because GrowSurf adds Mailchimp contacts with a status of `subscribed`. This means new contacts skip Mailchimp's double opt-in. To send Mailchimp welcome emails, you will need to [Create an Automated Welcome Email](https://mailchimp.com/help/create-an-automated-welcome-email/).
* GrowSurf never deletes contacts from Mailchimp.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.growsurf.com/integrations/mailchimp.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
