# Import Referral Program Data from SaaSquatch

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

#### CSV file column reference

<details>

<summary>Users data file</summary>

<table><thead><tr><th width="185.05078125">Column</th><th width="131.55078125">Required</th><th>Description</th></tr></thead><tbody><tr><td>User ID</td><td><img src="/files/NPCBDbQZqATuCYjtX6cO" alt="" data-size="original"></td><td>The participant's identifier.</td></tr><tr><td>Account ID</td><td><img src="/files/NPCBDbQZqATuCYjtX6cO" alt="" data-size="original"></td><td>The participant's account identifier.</td></tr><tr><td>Email</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The participant's email address.</td></tr><tr><td>First Name</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The participant's first name.</td></tr><tr><td>Last Name</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The participant's last name.</td></tr><tr><td>Referral Code</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The participant's primary program referral code (if specified).</td></tr><tr><td>Image URL</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The participant's image URL.</td></tr><tr><td>First Seen IP</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The IP address of the participant the first time they did a non-API upsert.</td></tr><tr><td>Last Seen IP</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The IP address of the participant the last time they did a non-API upsert.</td></tr><tr><td>Date Created</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The date this participant user was created, formatted in <a href="https://currentmillis.com/">milliseconds since unix epoch</a> .</td></tr><tr><td>Email Hash</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The MD5 hash value of a participant's email address.</td></tr><tr><td>Locale</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The participant's geographical location.</td></tr><tr><td>Country Code</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The participant's country code.</td></tr><tr><td>Segments</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The participant's user segments.</td></tr><tr><td>Share Link</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The participant's primary program (if specified) share link.</td></tr><tr><td>Facebook Share Link</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The participant's primary program (if specified) Facebook share link.</td></tr><tr><td>Twitter Share Link</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The participant's primary program (if specified) Twitter/X share link.</td></tr><tr><td>Email Share Link</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The participant's primary program (if specified) email share link.</td></tr><tr><td>LinkedIn Share Link</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The participant's primary program (if specified) LinkedIn share link.</td></tr><tr><td>Clean Share Link</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The participant's primary vanity link without encoding.</td></tr><tr><td>Custom Field</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>If a participant has a custom field, <code>{ExampleName}</code> will be the field name.</td></tr></tbody></table>

</details>

<details>

<summary>Referral data file</summary>

<table><thead><tr><th width="256.85546875">Column</th><th width="113.3828125">Required</th><th>Description</th></tr></thead><tbody><tr><td>Referred User - User ID</td><td><img src="/files/NPCBDbQZqATuCYjtX6cO" alt="" data-size="original"></td><td>The referred friend's external user id.</td></tr><tr><td>Referred User - Account ID</td><td><img src="/files/NPCBDbQZqATuCYjtX6cO" alt="" data-size="original"></td><td>The referred friend's external account id.</td></tr><tr><td>Referring User - User ID</td><td><img src="/files/NPCBDbQZqATuCYjtX6cO" alt="" data-size="original"></td><td>The customer advocate's external user id.</td></tr><tr><td>Referring User - Account ID</td><td><img src="/files/NPCBDbQZqATuCYjtX6cO" alt="" data-size="original"></td><td>The customer advocate's external account id.</td></tr><tr><td>Referral ID</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The referral's unique identifier.</td></tr><tr><td>Date Modified</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The date the referral was last modified (i.e. started, converted, moderated, etc.), formatted in <a href="https://currentmillis.com/">milliseconds since unix epoch</a> .</td></tr><tr><td>Date Referral Started</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The date the referral was created, formatted in <a href="https://currentmillis.com/">milliseconds since unix epoch</a> .</td></tr><tr><td>Date Converted</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The date the first goal was achieved, formatted in <a href="https://currentmillis.com/">milliseconds since unix epoch</a> .</td></tr><tr><td>Date User Modified</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The date a user was deleted from a referral (user deletion) or added to a referral, formatted in <a href="https://currentmillis.com/">milliseconds since unix epoch</a> .</td></tr><tr><td>Program ID</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The identifier of the program for which the referral was created.</td></tr><tr><td>Program Name</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The name of the program for which the referral was created.</td></tr><tr><td>Referred User - Email</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The referred friend's email address.</td></tr><tr><td>Referred User - First Name</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The referred friend's first name.</td></tr><tr><td>Referred User - Last Name</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The referred friend's last name.</td></tr><tr><td>Referred User - Referral Code</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The referred friend's primary referral code (depends on the program in which this referral was created.</td></tr><tr><td>Referred User - First Seen IP</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The first IP address the referred friend used when loading a widget.</td></tr><tr><td>Referred User - Last Seen IP</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The most recent IP address the referred friend used when loading widget.</td></tr><tr><td>Referred User - Image URL</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The referred friend's image.</td></tr><tr><td>Referred User - Locale</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The locale of the referred friend.</td></tr><tr><td>Referred User - Date Created</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The date the referred friend was first seen by SaaSquatch (created in SaaSquatch), formatted in <a href="https://currentmillis.com/">milliseconds since unix epoch</a> .</td></tr><tr><td>Referred User - Segments</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The referred friend's user segments.</td></tr><tr><td>referredUserCustomFields.&#x3C;fieldName></td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The referred friend's custom fields.</td></tr><tr><td>Referring User - Email</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The customer advocate's email address.</td></tr><tr><td>Referring User - First Name</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The customer advocate's first name.</td></tr><tr><td>Referring User - Last Name</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The customer advocate's last name.</td></tr><tr><td>Referring User - Referral Code</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The customer advocate's primary referral code (e.g. the referral code used to create this referral).</td></tr><tr><td>Referring User - First Seen IP</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The first IP address the customer advocate used when loading a widget.</td></tr><tr><td>Referring User - Last Seen IP</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The most recent IP address the customer advocate used when loading a widget.</td></tr><tr><td>Referring User - Image URL</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The customer advocate's image.</td></tr><tr><td>Referring User - Locale</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The locale of the customer advocate's.</td></tr><tr><td>Referring User - Date Created</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The date the customer advocate was first seen by SaaSquatch (created in SaaSquatch), formatted in <a href="https://currentmillis.com/">milliseconds since unix epoch</a> .</td></tr><tr><td>Moderation Status</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The referral fraud moderation status (e.g., <code>PENDING</code>, <code>ACTIONED</code>).</td></tr><tr><td>Date Moderated</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The date the referral started, formatted in <a href="https://currentmillis.com/">milliseconds since unix epoch</a> .</td></tr><tr><td>Referred User - Reward ID</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The referred friend's reward identifier.</td></tr><tr><td>Referring User - Reward ID</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The customer advocate's reward identifier.</td></tr><tr><td>Referrer User - Segments</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The customer advocate's user segments.</td></tr><tr><td>referrerUserCustomFields.&#x3C;fieldName></td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The customer advocate's custom fields.</td></tr><tr><td>Referral Code Used</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The customer advocate's referral code that was used for the referral.</td></tr><tr><td>Share Link Used</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The customer advocate's share link that was used for the referral.</td></tr></tbody></table>

</details>

<details>

<summary>Reward data file</summary>

<table><thead><tr><th width="203.2734375">Column</th><th width="118.1015625">Required</th><th>Description</th></tr></thead><tbody><tr><td>User ID</td><td><img src="/files/NPCBDbQZqATuCYjtX6cO" alt="" data-size="original"></td><td>The user's identifier.</td></tr><tr><td>Account ID</td><td><img src="/files/NPCBDbQZqATuCYjtX6cO" alt="" data-size="original"></td><td>The user's account identifier.</td></tr><tr><td>Type</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The <a href="/pages/R1kQ1Z0PaVSrnM79RMTQ">type of reward</a>, e.g., Credit, Discount, Gift card, etc.</td></tr><tr><td>Reward Unit</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The unit in which rewards are earned, e.g., Cash, Points, Months, etc.</td></tr><tr><td>Reward Value</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>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).</td></tr><tr><td>Reward Name</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The name you assigned to the reward when creating it in your program.</td></tr><tr><td>USD Value</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The value of the reward in USD.</td></tr><tr><td>Program ID</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The identifier of the program for which the reward was created.</td></tr><tr><td>Global Reward Key</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>Key of the global reward configuration in the reward catalog. This is under <strong>Rewards → Catalog → Create rewards → Reward Name</strong>.</td></tr><tr><td>Reward Source</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>How the reward was created, e.g., <em>Manual</em>, <em>Referred user</em>, <em>Friend sign up</em>.</td></tr><tr><td>Date Created</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The date the reward was earned, formatted in <a href="https://currentmillis.com/">milliseconds since unix epoch</a> .</td></tr><tr><td>Date Given</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The date the reward was given, formatted in <a href="https://currentmillis.com/">milliseconds since unix epoch</a> . (This value can differ from <em>Date Created</em> if the reward was pending).</td></tr><tr><td>Date Scheduled For</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The date the reward was scheduled to be given to the user, formatted in <a href="https://currentmillis.com/">milliseconds since unix epoch</a> .</td></tr><tr><td>Date Expires</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The date after which the reward can no longer be redeemed, formatted in <a href="https://currentmillis.com/">milliseconds since unix epoch</a> .</td></tr><tr><td>Date Cancelled</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The date you cancelled the reward, formatted in <a href="https://currentmillis.com/">milliseconds since unix epoch</a> .</td></tr><tr><td>Date Modified</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The date you made modifications to the reward, formatted in <a href="https://currentmillis.com/">milliseconds since unix epoch</a> .</td></tr><tr><td>Date Redeemed</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The date the full reward was redeemed by the user, formatted in <a href="https://currentmillis.com/">milliseconds since unix epoch</a> .</td></tr><tr><td>Assigned Credit</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The amount in the base unit for Credit rewards. This is the equivalent of <em>Reward Value</em>, but for Credit rewards.</td></tr><tr><td>Redeemed Amount</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The <em>Value</em> of the portion of the reward that was redeemed.</td></tr><tr><td>Fuel Tank Type</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>This can be either <em>Credit</em> or <em>% discount</em>.</td></tr><tr><td>Fuel Tank Code</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>This is like coupon code, e.g., <em>SummerSave20</em>, <em>20%OFF</em>, etc.</td></tr><tr><td>Referred User ID</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The user identifier of the referred friend.</td></tr><tr><td>Referred Account ID</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>The identifier of the referred friend's account.</td></tr><tr><td>referral.referredUser.id</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>Used in conjunction with <em>Program ID</em> to link a referral to a Program ID, if we want to attach a referral to a reward. This may not always match the <em>User ID</em>.</td></tr><tr><td>referral.referredUser.accountId</td><td><img src="/files/Z4ih0aYfWwOCuDbAAWs3" alt="" data-size="original"></td><td>Used in conjunction with <em>Program ID</em> to link a referral to a Program ID, if we want to attach a referral to a reward. This may not always match the <em>Account ID</em>.</td></tr></tbody></table>

</details>

#### 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](https://currentmillis.com/) .
   * `MISSING_FIELD` — e.g., a required field such as *User ID* or *Account ID* is missing.

   <div data-with-frame="true"><figure><img src="/files/kmvIWlvxqMmbaXk9hfwV" alt="" width="563"><figcaption></figcaption></figure></div>
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.

   <div data-with-frame="true"><figure><img src="/files/HnA74tUkAY6jaVqo2AtK" alt=""><figcaption></figcaption></figure></div>
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:
   1. In the left navigation bar, select ![](/files/CDnwOBeIdds9r3Z6zTnO) **\[Engage] → Reporting**.
   2. Select **Imports & Exports** to view the report.


---

# Agent Instructions: 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 current page URL with the `ask` query parameter:

```
GET https://help.impact.com/brand/what-would-you-like-to-learn-about/advocate-program/getting-started-with-advocate/import-referral-program-data-from-saasquatch.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
