Warning
This process will permanently remove the selected participants and all of their historical data, including referrals and rewards, events, custom fields and more. Deleted data is not recoverable. Before starting the deletion process, we recommend confirming that all participants in your upload file should be permanently erased from your Advocate program. See our document on Participant Deletion for more information.
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 Reporting → Imports & Exports.
Select
Import.Under Choose an Import Type, select Delete Users.
To upload your file, select Select File.
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 deletes require only an id and accountId for the users to be deleted, and have some optional fields depending on the behavior required. Fields are case sensitive.
Field | Type | Description |
|---|---|---|
accountId | String Required | The unique identifier of the Account that this user belongs to. |
id | String Required | The unique identifier provided for this user. |
preserveEmptyAccount | boolean | If the user’s account is left with no users, by default the account will be deleted. If set, this field will result in the empty account being preserved. This will override the global |
doNotTrack | boolean | Specify |
We notify you by email when your import is complete. You can download the results from the Reporting → Imports & Exports.
If the import completes successfully, a file with the account and user IDs of the deleted participants will be generated and emailed to you.
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.
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.