For the complete documentation index, see llms.txt. This page is also available as Markdown.

EmailOctopus

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

Sync with your EmailOctopus List

Step 1: In Program Editor > 4. Options > Integrations, open the EmailOctopus integration card and enter your EmailOctopus API key (click here to get your EmailOctopus private API key).

Connect EmailOctopus before importing participants. If participants are already in your program, follow these ESP sync options to send their GrowSurf data to EmailOctopus.

Step 2: Once connected, choose the EmailOctopus list that you want to automatically sync to. GrowSurf will add/update your EmailOctopus 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:

Examples

View our EmailOctopus tutorials to see different kinds of examples that you can copy/paste into your email templates.

Custom Fields

GrowSurf will automatically create these custom fields for your EmailOctopus contacts.

Field label

Tag

Type

Description

Example

GrowSurf Share URL

GrowSurfShareURL

TEXT

The participant's unique referral link

https://growsurf.com?grsf=absc123

GrowSurf Participant ID

GrowSurfParticipantID

TEXT

The participant's unique GrowSurf ID

abc123

GrowSurf Referral Status

GrowSurfReferralStatus

TEXT

The referral status of the participant*

CREDIT_PENDING

GrowSurf Participant First Name

GrowSurfParticipantFirstName

TEXT

The participant's first name

Bob

GrowSurf Participant Last Name

GrowSurfParticipantLastName

TEXT

The participant's last name

Loblaw

GrowSurf Referrer First Name

GrowSurfReferrerFirstName

TEXT

The first name of the participant's referrer (if applicable)

Gavin

GrowSurf Referrer Last Name

GrowSurfReferrerLastName

TEXT

The last name of the participant's referrer (if applicable)

Belson

GrowSurf Referrer Email

GrowSurfReferrerEmail

TEXT

The email address of the participant's referrer (if applicable)

gavin.belson@hoolie.io

GrowSurf Total Referral Count

GrowSurfTotalReferralCount

NUMBER

The participant's all-time referral count

0

GrowSurf Lead Count

GrowSurfLeadCount

NUMBER

The participant's current lead count (pending referrals that have not converted yet)

0

GrowSurf Monthly Referral Count

GrowSurfMonthlyReferralCount

NUMBER

The participant's current month referral count

19

GrowSurf Prev Monthly Referral Count

PrevMonthlyReferralCount

NUMBER

The participant's previous month referral count

20

GrowSurf Next Milestone

GrowSurfNextMilestone

TEXT

The text for the next/upcoming milestone reward (only applies to milestone rewards. See an example here)

You are only 2 referrals away from winning a free t-shirt!

GrowSurf Next Monthly Milestone

GrowSurfNextMonthlyMilestone

TEXT

The text for the next/upcoming monthly milestone reward (only applies to milestone rewards. See an example here)

You are only 2 referrals away from winning a free t-shirt!

GrowSurf Total Invite Count

GrowSurfTotalInviteCount

NUMBER

The participant's all-time invite count

112

GrowSurf Total Impression Count

GrowSurfTotalImpressionCount

NUMBER

The participant's all-time impression count

150

GrowSurf Language

GrowSurfLanguage

TEXT

The participant's program language (ISO code such as es or pt-BR)

es

*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 new tags in your EmailOctopus email templates. For example, use GrowSurfShareURL to add each participant's unique referral link.

Troubleshooting Tips

  • Check the participant's activity logs if they do not sync. GrowSurf retries failed syncs for up to 7 days.

Last updated

Was this helpful?