← View All Guides
EmailOctopus logo
Integration Guide

How to Sync GrowSurf Referral Data to EmailOctopus

One API key, one list, and every contact carries their referral link as a custom field.

Want the full setup walkthrough?

Use these docs for exact setup steps, supported fields, and troubleshooting.

GrowSurf adds and updates contacts in the EmailOctopus list you choose and creates 15 custom fields holding each participant’s referral link, referral counts, referrer details, and milestone progress.

EmailOctopus keeps custom fields and tags separate: fields store values you can print in a campaign, tags group people. GrowSurf writes fields, so every value is available to your email content.

Integration Steps

Get an EmailOctopus API key

Copy your private API key from your EmailOctopus API settings.

Connect EmailOctopus in GrowSurf

Open Program Editor > 4. Options > Integrations and search for EmailOctopus.

Searching for EmailOctopus in the GrowSurf Program Editor integrations list
Search the integrations list in Program Editor > 4. Options > Integrations.

Expand the card, paste the API key, and submit.

The EmailOctopus API key field in the GrowSurf Program Editor
Paste the API key and submit.

Connect before you import participants; the sync only covers people added or referred afterwards. If you have already imported, use the existing-participant sync options.

Choose the list and save

Pick the EmailOctopus list GrowSurf should keep current, then save changes. Contacts are added or updated there every time someone joins your program or gets referred.

Know your field tags

GrowSurf dataField tagTypeWhat it holds
Share URLGrowSurfShareURLTextThe participant’s unique referral link
Participant IDGrowSurfParticipantIDTextThe participant’s GrowSurf ID
Referral StatusGrowSurfReferralStatusTextCREDIT_PENDING, CREDIT_AWARDED, or CREDIT_EXPIRED
Participant first nameGrowSurfParticipantFirstNameTextThe participant’s first name
Participant last nameGrowSurfParticipantLastNameTextThe participant’s last name
Referrer first nameGrowSurfReferrerFirstNameTextThe referrer’s first name, when there is one
Referrer last nameGrowSurfReferrerLastNameTextThe referrer’s last name, when there is one
Referrer emailGrowSurfReferrerEmailTextThe referrer’s email, when there is one
Total referral countGrowSurfTotalReferralCountNumberAll-time referral count
Monthly referral countGrowSurfMonthlyReferralCountNumberReferral count for the current month
Previous monthly referral countPrevMonthlyReferralCountNumberReferral count for the previous month
Next milestoneGrowSurfNextMilestoneTextThe next milestone message, on programs with milestone rewards
Next monthly milestoneGrowSurfNextMonthlyMilestoneTextThe next monthly milestone message, when there is one
Total invite countGrowSurfTotalInviteCountNumberAll-time invite count
Total impression countGrowSurfTotalImpressionCountNumberAll-time referral-link view count

In campaign content, wrap the tag in double curly braces — the Share URL field tag GrowSurfShareURL is written as {{GrowSurfShareURL}}.

Tips

Fields, not tags

EmailOctopus tags group contacts; only custom fields hold a printable value. GrowSurf uses fields, which is why the referral link is available in your campaign body.

The tag name and the merge syntax differ

The field tag is GrowSurfShareURL. In an email you write {{GrowSurfShareURL}}. Confusing the two is the usual cause of a blank link.

Connect first, import second

The sync does not backfill on its own.

FAQ

Does GrowSurf create the fields?

Yes, once the integration is connected and a list is selected.

What is the difference between an EmailOctopus tag and a field?

Tags group contacts for targeting. Fields store values you can insert into campaign content. GrowSurf writes fields.

How do I insert the referral link?

{{GrowSurfShareURL}}.

Trusted by marketing and product teams that grow through customer, user, and partner referrals.