> 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/activecampaign.md).

# ActiveCampaign

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

## Sync with your ActiveCampaign List <a href="#sync-with-your-activecampaign-list" id="sync-with-your-activecampaign-list"></a>

**Step 1:** In *Program Editor > 4. Options > Integrations*, open the ActiveCampaign integration card and enter your ActiveCampaign API URL and key ([click here to get your ActiveCampaign API URL and key](https://help.activecampaign.com/hc/en-us/articles/207317590-Getting-started-with-the-API#how-to-obtain-your-activecampaign-api-url-and-key)).

{% hint style="info" %}
Connect ActiveCampaign 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 ActiveCampaign.
{% endhint %}

![](https://2794996218-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LeklWo0yn03AhWro2Ux%2F-MKcNbj1E08EsaGbGrY8%2F-MKcOKKEaAydJgcpXcgu%2FScreen%20Shot%202020-10-26%20at%2011.39.26%20PM.png?alt=media\&token=b788a595-ecf4-47a1-b032-d75749274271)

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

**Step 3:** Save changes. You should now see a screen that looks like the one below:

![](https://2794996218-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LeklWo0yn03AhWro2Ux%2F-MKcNbj1E08EsaGbGrY8%2F-MKcOKKKYqZ7EKbLwPC7%2FScreen%20Shot%202020-10-26%20at%2011.38.58%20PM.png?alt=media\&token=92ec91ca-ee98-4f0e-bba3-be844404f395)

**Step 4:** Open your ActiveCampaign account, and go to *Lists > Manage Fields.*

Click the edit icon next to each GrowSurf field that you want available for ActiveCampaign contacts (see screenshot below):

![](https://2794996218-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LeklWo0yn03AhWro2Ux%2F-MUyQggzYPzaqH-2tdvB%2F-MUyRGjw2pamQ1XSnM8z%2Fimage.png?alt=media\&token=bb697f69-e043-49eb-ad89-b5fff39f369c)

Then in the *Customize the Field Options* window, check the same ActiveCampaign list that you selected in the GrowSurf Program Editor.

![](https://2794996218-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LeklWo0yn03AhWro2Ux%2F-MKebWpk_QH8HDpX9fwO%2F-MKetPi8z4pnjKu9H00E%2FScreen%20Shot%202020-10-27%20at%2011.27.54%20AM.png?alt=media\&token=1116ea1d-e189-4778-9dc7-b4eb2f3c37c3)

For more help in editing custom contact fields, please see ActiveCampaign's help article [*How do I edit a custom contact field?*](https://help.activecampaign.com/hc/en-us/articles/115001623804-How-do-I-edit-a-custom-contact-field-)*.*

## Examples

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

## **Contact Fields** <a href="#subscriber-fields" id="subscriber-fields"></a>

GrowSurf will automatically create these new contact fields for your ActiveCampaign Contacts.

To use them, you'll first need to [follow step #4 in the instructions above](https://docs.growsurf.com/integrations/activecampaign#sync-with-your-activecampaign-list).

| **Field Name**                           | **Personalization Tag**                  | **Type** | **Description**                                                                                                                                                                                           | **Example**                                                |
| ---------------------------------------- | ---------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| **GrowSurf Share URL**                   | `%GROWSURF_SHARE_URL%`                   | TEXT     | The participant's unique referral link                                                                                                                                                                    | <https://growsurf.com?grsf=absc123>                        |
| **GrowSurf Participant ID**              | `%GROWSURF_PARTICIPANT_ID%`              | TEXT     | The participant's unique GrowSurf ID                                                                                                                                                                      | abc123                                                     |
| **GrowSurf Referral Status**             | `%GROWSURF_REFERRAL_STATUS_ID%`          | TEXT     | The referral status of the participant\*                                                                                                                                                                  | CREDIT\_PENDING                                            |
| **GrowSurf Participant First Name**      | `%GROWSURF_PARTICIPANT_FIRST_NAME%`      | TEXT     | The participant's first name                                                                                                                                                                              | Bob                                                        |
| **GrowSurf Participant Last Name**       | `%GROWSURF_PARTICIPANT_LAST_NAME%`       | TEXT     | The participant's last name                                                                                                                                                                               | Loblaw                                                     |
| **GrowSurf Referrer First Name**         | `%GROWSURF_REFERRER_FIRST_NAME%`         | TEXT     | The first name of the participant's referrer (if applicable)                                                                                                                                              | Gavin                                                      |
| **GrowSurf Referrer Last Name**          | `%GROWSURF_REFERRER_LAST_NAME%`          | TEXT     | The last name of the participant's referrer (if applicable)                                                                                                                                               | Belson                                                     |
| **GrowSurf Referrer Email**              | `%GROWSURF_REFERRER_EMAIL%`              | TEXT     | The email address of the participant's referrer (if applicable)                                                                                                                                           | <gavin.belson@hoolie.io>                                   |
| **GrowSurf Total Referral Count**        | `%GROWSURF_TOTAL_REFERRAL_COUNT%`        | NUMBER   | The participant's all-time referral count                                                                                                                                                                 | 0                                                          |
| **GrowSurf Lead Count**                  | `%GROWSURF_LEAD_COUNT%`                  | NUMBER   | The participant's current lead count (pending referrals that have not converted yet)                                                                                                                      | 0                                                          |
| **GrowSurf Monthly Referral Count**      | `%GROWSURF_MONTHLY_REFERRAL_COUNT%`      | NUMBER   | The participant's current month referral count                                                                                                                                                            | 19                                                         |
| **GrowSurf Prev Monthly Referral Count** | `%GROWSURF_PREV_MONTHLY_REFERRAL_COUNT%` | NUMBER   | The participant's previous month referral count                                                                                                                                                           | 200                                                        |
| **GrowSurf Next Milestone**              | `%GROWSURF_NEXT_MILESTONE%`              | TEXT     | The text for the next/upcoming milestone reward (only applies to milestone rewards. [See](https://docs.growsurf.com/developer-tools/embeddable-elements#embedded-next-milestone) an example here)         | You are only 2 referrals away from winning a free t-shirt! |
| **GrowSurf Next Monthly Milestone**      | `%GROWSURF_NEXT_MONTHLY_MILESTONE%`      | TEXT     | The text for the next/upcoming monthly milestone reward (only applies to milestone rewards. [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! |
| **GrowSurf Total Invite Count**          | `%GROWSURF_TOTAL_INVITE_COUNT%`          | NUMBER   | The participant's all-time invite count                                                                                                                                                                   | 112                                                        |
| **GrowSurf Total Impression Count**      | `%GROWSURF_TOTAL_IMPRESSION_COUNT%`      | NUMBER   | The participant's all-time impression count                                                                                                                                                               | 150                                                        |

\**GrowSurf Referral Status* 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 personalization tags in your ActiveCampaign email templates. For example, use `%GROWSURF_SHARE_URL%` to add each participant's unique referral link.

[​Learn more about ActiveCampaign personalization tags here.​](https://help.activecampaign.com/hc/en-us/articles/220709307-Personalization-Tags#how-personalization-tags-work)

## **Troubleshooting Tips** <a href="#troubleshooting-tips" id="troubleshooting-tips"></a>

* Check the participant's activity logs if they do not sync. GrowSurf retries failed syncs for up to 7 days.
* **If GrowSurf custom fields are missing on an ActiveCampaign contact, or a personalization tag shows up as red in an email:**
  * Make each custom field available for your ActiveCampaign list. [See step #4 in the instructions above](https://docs.growsurf.com/integrations/activecampaign#sync-with-your-activecampaign-list).

[<br>](https://docs.growsurf.com/additional-integrations/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 following URL with the `ask` and `goal` query parameters:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `build a script that syncs our docs to a CMS` lets GitBook tailor the answer to that use case.

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.
