help center

| Submit or View Help Requests | Developer Docs |
|

Import / advocate Participants in Bulk

SaaSquatch accepts imports submitted in .csv or .jsonl file formats. Please reference our sample CSV import file and sample JSONL import file to view the required file structure for your import.

Note

We recommend that each import does not exceed 500,000 entries.

Import participants in bulk

  1. Go to the Participants page.

  2. Select Import Users.

  3. Under Choose an Import Type, select Users.

  4. Add your import file by selecting Select & Upload.

  5. [Optional] To add or remove the imported participants from a specific user segment, select the segment from the dropdown list.

    Note

    This selection applies to all participants included in this import file.

  6. Select Start Import.

When the import completes, a confirmation email is sent. Imports may take up to 30 minutes, depending on queue and file size.

Fields

Bulk user imports support both Standard Fields and Custom fields in the upload file. Fields are case-sensitive.

Standard fields are parsed with the same validation as our Open Endpoint User Upsert API call:

Field

Type

Description

accountId

Requiredstring

The unique identifier of the Account that this user belongs to.

id

Requiredstring

The unique identifier provided for this user.

firstName

string

The user’s first name

lastName

string

The user’s last name

email

string

The email address for the user.

referable

boolean

Flag used by the SaaSquatch system to determine whether a user is able to be referred.

Note

Flag must be spelled with only one r for status to be modified successfully.

locale

string

The user’s locale, used for Internationalization. The locale must be of the format language_COUNTRY where the language code must be lowercase and the country code must be uppercase. The separator must be an underscore.

countryCode

string

The user’s locale, used for Internationalization. The user’s country code (e.g CA)

referredBy.code

string

The referral code of the Referrer who referred this user.

referralCodes.{programId}

string

The vanity referral code for this user to share for the specified program (automatically generated if not included)

sharelinks.{programId}

string

The vanity share link for this user to share for the specified program (automatically generated if not included)

dateCreated

string

The user’s creation date

imageUrl

string

Optionally used in widgets, emails, and themes. If you provide an absolute profile image URL the minimum image size is 80px x 80px.

dateUsTaxFormSubmitted

integer

The date that a user’s W-9 Tax Form was marked as collected. Used for W-9 Compliance on your tenant, if configured

customFields.{fieldName}

string

Use this structure to include a custom field of your choosing

Results

We notify you by email when your import is complete. You can download import results from the Reports page within the Analytics section.

Note

Download links will expire after 30 days.

If the import completes successfully, a file with the participant information will be generated and emailed to you. The information that is included in these results is the same as is found in our user details report.

Did you find it helpful? Yes No

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