SaaSquatch Help Center

The SaaSquatch portal provides a quick and easy way to bulk upload users into your SaaSquatch project to create or update user information.

Want to add/update more than one user at a time within your SaaSquatch project? Looking to transfer in large numbers of existing customers?

The Import Users tool allows you to submit requests for bulk additions or updates to users in your SaaSquatch project. Read this guide to find out more about how to make use of this import functionality.

Click on Import Users on the right-hand side of the Participants page in the SaaSquatch portal to get started.

🔗 Upload Format

The SaaSquatch system accepts user imports to be submitted in .csv file format, and it is recommended that each import does not exceed 500,000 entries.

Please refer to our sample import file for an example of the correct import file format.

Once submitted, the job will be placed in a queue to be processed by the SaaSquatch system. This process could take a few minutes to complete depending on current system load. You will receive a confirmation email when the import has completed.

🔗 Standard Fields

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

Field Type Description
accountId Required string The unique identifier of the Account that this user belongs to.
id Required string 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.
referralCode string The referral code used for sharing by this user
Classic only Note: Only used by classic referral programs.
paymentProviderId string The paymentProviderId is either the Stripe Customer ID or the Recurly Account ID.
Note: This field cannot be updated. Do not include this arguement on an API-only program, or unless looking to set it.
Classic only Note: Only used by classic referral programs.
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.
referredBy.code string The referral code of the Referrer who referred this user.
referredBy.isConverted string The referral status of the Referred User.
Classic only Note: Only used by classic referral programs.
imageUrl string Optionally used in widgets, emails, and themes. If you provide a absolute profile image URL the minimum image size is 80px x 80px.

🔗 Custom Fields

It is also possible to include custom user fields in your import. These fields should be included using the format customFields.yourCustomFieldName for the column header.

Growth Automation programs can be configured to convert based on a custom field such as a birthdate or payment of a subscription. e.g. For the Birthday Program, uploading a participant's birthday in --MM-DD format in the customFields.birthday field will allow participants to partake in a program that offers them rewards on or around their birthday.

Another example would be a referral program that is designed to convert when the referred user renews their subscription. You could upload yes in the customFields.subscriptionPaid field to trigger conversion of the program.

Note: Custom fields are not able to accept array or object values.

🔗 User Segments

User Segmentation options are provided on the page alongside the request to create an import. For more information on segments, see our User Segmentation Guide.

🔗 Results

When your upload completes you will receive an email notifying you of the result.

The results of the import are also available for download from the Import and Export Jobs page within the Reporting section in the SaaSquatch portal.

Please Note: Download links will expire after 30 days.

🔗 Successful Upload

If the import completes successfully, a file with the user information of those that were successfully imported will be generated and emailed to you.

The user information that is included in these results is the same as is found in our User Details Report.

🔗 Errors

If any non-fatal errors are encountered during the import, then a second results file will also be generated (in addition to the file with the successfully uploaded records). The errors file includes entries for each error that occurred, including the row number of the record (from the initial import file) that failed, and any associated error messages:

recordNumber message apiErrorCode statusCode
2 This request requires a valid non-empty id BAD_REQUEST 400

In the unlikely event that a fatal system error occurs and the import is interrupted, then the import will appear as aborted and will not recover. Please our Success Team for further assistance.