Help Center

| Submit or View Help Requests | Developer Docs |
  1. impact.com Help Center
  2. I'm a Brand
  3. Getting Started with Advocate

View desktop instructions
View mobile app instructions
Import Your Referral Program Data

Published on: Mon, 9 Sep, 2024 at 9:28 AM  |  Updated on: Wed, 23 Oct, 2024 at 6:18 AM

When you transition from your referral platform to impact.com's Advocate offering, you get access to an expert team dedicated to setting you up efficiently and successfully. If you're looking to learn more about what it would look like to move your program over to impact.com, email [email protected] for a no-strings-attached demo.

The migration process

impact.com typically recommends notifying your partners about the transition as soon as possible. It's also recommended to have some overlap between closing down your old program and running the advocate program.

Once the impact.com team gets the green light to begin migration, we'll help you import your user, reward, and referral data history from your previous platform. You'll be able to map fields from your referral program to impact.com.

Field_mapping.png

What can be moved

  • User data: This includes email addresses, referral codes, sharelinks, and more. You can also add custom fields.

  • Referral data: This includes referral start dates, converted dates, and more. You can also add custom fields.

  • Reward data: This includes reward values, dates given and redeemed, redeemed amounts, and more. You can also add custom fields.

Note: Some fields can be mapped twice to the same destination field, e.g., you may want to map a user's email address to both the User ID and Account ID.

What you'll need to do

  • Export your program's user data, referral data, and reward data. Either contact your CSM on your old referral platform for assistance, or use an in-platform export tool if one is provided.

  • Download each of the 3 data reports in a separate CSV file, e.g., user_data.CSV, referral_data.CSV, and reward_data.CSV.

    User data

    Referral data

    Reward data

    id,accountId,email,firstName,lastName,imageUrl,dateCreated,dateBlocked,dateUsTaxFormSubmitted,locale,countryCode,segments,customFields.purchases,programShareLinks.obj-referral,referralCodes.obj-referral
User 1,User 1,[email protected],User 1,User 1,,1725403259029,,1725472637704,en_US,US,"vip,newuser",3,https://share.squatchtesting.com/mzbnr7n,USER1USER1
User 2,User 2,[email protected],User 2,User 2,,1725403279400,1725403280000,,en_US,US,vip,1,https://share.squatchtesting.com/mzbnr7q,USER2USER2
User 3,User 3,[email protected],User 3,User 3,,1725403313992,,,en_US,US,,3,https://share.squatchtesting.com/mzbnr7t,USER3USER3
User 4,User 4,[email protected],User 4,User 4,,1725403332504,,,en_US,US,newuser,1,https://share.squatchtesting.com/mzbnr7w,USER4USER4"User ID","Account ID","Email","First Name","Last Name","Image URL","First Seen IP","Last Seen IP","Date Created - YYYY-MM-DD","Email Hash","Referral Source","Locale","Country Code","shareLink","facebookShareLink","twitterShareLink","emailShareLink","linkedinShareLink","cleanShareLink","customFields.{fieldName}"
12345,54321,[email protected],Noah,Lott,https://site/gallery/5555,192.158.1.38,192.168. 1.1,4/11/2024,8743b52063cd84097a65d1633f5c74f5,,en_US,+1,share.yourdomain.com/mzw&lkO,,,,,share.yourdomain.com/INFLUENCER10,customFields.{exampleField}
customFields.{exampleField}"

Important: All 3 export files should contain data from a single program only. If the files have data from multiple programs, the import will consolidate it into a single program.

Destination field reference

Users data file

Column

Required

Description

User ID

[Checked box green]

The participant's identifier.

Account ID

[Checked box green]

The participant's account identifier.

Email

[Exit]

The participant's email address.

First Name

[Exit]

The participant's first name.

Last Name

[Exit]

The participant's last name.

Referral Code

[Exit]

The participant's primary program referral code (if specified).

Image URL

[Exit]

The participant's image URL.

Date Created

[Exit]

The date this participant participant was created, formatted in milliseconds since unix epoch [External link].

Locale

[Exit]

The participant's geographical location.

Country Code

[Exit]

The participant's country code.

Share Links

[Exit]

The participant's primary program (if specified) share link.

Custom Field

[Exit]

The participant's custom fields.

Referral data file

Column

Required

Description

Referred User ID

[Checked box green]

The referred friend's external user id.

Referred Account ID

[Checked box green]

The referred friend's external account id.

Customer Advocate User ID

[Checked box green]

The customer advocate's external user id.

Customer Advocate Account ID

[Checked box green]

The customer advocate's external account id.

Referral Start Date

[Exit]

The date the referral was created, formatted in milliseconds since unix epoch [External link].

Referral Converted Date

[Exit]

The date the first goal was achieved, formatted in milliseconds since unix epoch [External link].

Custom Field

[Exit]

The customer advocate's custom fields.

Reward data file

Column

Required

Description

User ID

[Checked box green]

The participant's identifier.

Account ID

[Checked box green]

The participant's account identifier.

Reward Unit

[Exit]

This is a unit of your reward (e.g., POINT or CASH), and can include alphanumeric characters in any casing as well as underscores.

Reward Value

[Exit]

This is the numeric value of the reward in its smallest measurement unit, e.g., for a cash reward of $1.00, the value would be 100 (cents).

This field must be in 1 of the following formats:

  • <unitNameOrCurrency> — if the Reward Unit is Cash, then the reward value will have that currency code. If not cash, then this field can contain any characters except * and /. E.g., USD.

  • <unitName>/<Currency> — unitName can consist of alphanumeric characters in any casing as well as underscores. Currency must be a valid 3 character currency code in uppercase. E.g., Cash/USD.

This field cannot:

  • be an empty string

  • have leading or trailing whitespace

  • contain a * character

  • contain more than 1 / character

Reward Name

[Exit]

The name you assigned to the reward when creating it in your program.

Date Created

[Exit]

The date the reward was earned, formatted in milliseconds since unix epoch [External link].

Date Given

[Exit]

The date the reward was given, formatted in milliseconds since unix epoch [External link]. (This value can differ from Date Created if the reward was pending).

Date Scheduled For

[Exit]

The date the reward was scheduled to be given to the user, formatted in milliseconds since unix epoch [External link].

Date Expires

[Exit]

The date after which the reward can no longer be redeemed, formatted in milliseconds since unix epoch [External link].

Date Cancelled

[Exit]

The date you cancelled the reward, formatted in milliseconds since unix epoch [External link].

Date Redeemed

[Exit]

The date the full reward was redeemed by the user, formatted in milliseconds since unix epoch [External link].

Redeemed Amount

[Exit]

The Value of the portion of the reward that was redeemed.

Referred User ID

[Exit]

The user identifier of the referred friend.

Referred Account ID

[Exit]

The identifier of the referred friend's account.

Custom Field

[Exit]

The customer advocate's custom fields.

Validation error reference

You can get 3 types of validation errors:

  1. Inline error message: these appear in the preview validation table and cause error rows to be highlighted in red:

    • INVALID_FIELD — e.g., the Date Created field wasn't formatted in milliseconds since unix epoch [External link].

    • MISSING_FIELD — e.g., a required field such as User ID or Account ID is missing.

    Screenshot_2024-09-17_at_11_16_19_AM.png

  2. Error callout: these appear in place of the preview validation table as red warning messages:

    • MISSING_HEADER — e.g., a required column header such as Account ID or Reward Value is missing.

    • CSV_PARSING — e.g., the CSV file contains special characters that are improperly formatted.

    • FILE_REF_IO — e.g., the file is corrupted and can't be read.

    Screenshot_2024-09-17_at_11_17_20_AM.png

  3. Listed errors: these appear as a list of error counts on the Imports & Exports screen when the import type doesn't have a preview validation table. Row errors and file errors will display together:

    Screenshot_2024-09-10_at_10_58_19_AM.png

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.

Related Articles