Help Center

| Submit or View Help Requests | Developer Docs |

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

This article houses useful references to assist you in importing your referral platform data to impact.com from another referral platform.

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

times-solid.svg

The participant's email address.

First Name

times-solid.svg

The participant's first name.

Last Name

times-solid.svg

The participant's last name.

Referral Code

times-solid.svg

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

Image URL

times-solid.svg

The participant's image URL.

Date Created

times-solid.svg

The date this participant participant was created, formatted in milliseconds since unix epoch External Link.

Locale

times-solid.svg

The participant's geographical location.

Country Code

times-solid.svg

The participant's country code.

Share Links

times-solid.svg

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

Custom Field

times-solid.svg

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

times-solid.svg

The date the referral was created, formatted in milliseconds since unix epoch External Link.

Referral Converted Date

times-solid.svg

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

Custom Field

times-solid.svg

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

times-solid.svg

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

times-solid.svg

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

times-solid.svg

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

Date Created

times-solid.svg

The date the reward was earned, formatted in milliseconds since unix epoch External Link.

Date Given

times-solid.svg

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

times-solid.svg

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

Date Expires

times-solid.svg

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

Date Cancelled

times-solid.svg

The date you cancelled the reward, formatted in milliseconds since unix epoch External Link.

Date Redeemed

times-solid.svg

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

Redeemed Amount

times-solid.svg

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

Referred User ID

times-solid.svg

The user identifier of the referred friend.

Referred Account ID

times-solid.svg

The identifier of the referred friend's account.

Custom Field

times-solid.svg

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.