Advocate 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.
From the left navigation menu, select Participants.
Select Import Users.
Under Import Type, select Users.
Add your import file by selecting Select File.
-
[Optional] To add or remove the imported participants from a specific user segment, select the segment from the dropdown list.
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.
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 participant belongs to. |
id |
Requiredstring |
The unique identifier provided for this participant. |
firstName |
string |
The participant’s first name. |
lastName |
string |
The participant’s last name. |
string |
The email address for the participant. |
|
referable |
boolean |
Flag used by impact.com to determine whether a participant is able to be referred. |
locale |
string |
The participant’s locale, used for Internationalization. The locale must be of the format |
countryCode |
string |
The participant’s locale, used for Internationalization. The user’s country code (e.g CA). |
referredBy.code |
string |
The referral code of the customer advocate who referred this participant. |
referralCodes.{programId} |
string |
The vanity referral code for this participant to share for the specified program (automatically generated if not included). |
sharelinks.{programId} |
string |
The vanity share link for this participant to share for the specified program (automatically generated if not included). |
dateCreated |
string |
The date this participant was created in your Advocate program. |
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 participant’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. |
Custom user fields allow for data unique to your participants. You can set your program goals to trigger based on the information in a custom user field.
Example: Reward participants when they renew their subscription membership. First, include the custom field customFields.subscriptionPaid with the value of yes. Then, set the goal to convert when customFields.subscriptionPaid is equal to yes.
Add custom fields to the column header in this format: customFields.yourCustomFieldName.
We notify you by email when your import is complete. You can download import results from the Reporting → Imports & Exports page within your Advocate program.
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.
If any errors are encountered during the import, then an additional file will be generated. This 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 system error occurs and the import is interrupted, then the import will appear as aborted and will not recover. Please reach out to our Support team if you need further assistance.