To delete invalid, inactive or unneeded users from an Iterable project, use one of Iterable's user deletion APIs or the bulk user deletion tool.
Deleting users completely removes all of their information from an Iterable project, including:
- User profile
- Subscription preferences
- List memberships
- Campaign events (sends, opens, clicks, etc.).
- Custom events
- Iterable cannot restore deleted users or any associated data.
- Deleting users impacts historical campaign metrics, which are recalculated as though the campaigns in question were never sent to the deleted users.
- Before deleting users, consider backing up important data.
Table of contents
Backing up important data
Before deleting users, back up their data as necessary. To do this, use Iterable's web interface and API, as described below.
To learn more about Iterable's API, take a look at:
To back up user profile data (which contains custom fields, subscription information and device information):
Use Iterable's web interface to export multiple user profiles simultaneously:
- Navigate to Audience > Segmentation.
- Create a static list containing the users whose profiles you'd like to back up. Click Refresh Results and verify its contents.
- Click Export As > CSV File and select the fields to save.
- Save the CSV file to your local machine.
Alternatively, call one of the following APIs to save the user profile for a single user:
Users on a list
For a full list of the users that belong to a particular list, call
For a list of messages that have been sent to a particular user, call
To export campaign data:
Use Iterable's web interface to export campaign metrics and aggregate analytics:
- Navigate to Messaging > Campaigns and use the Export Campaign Metrics by Date Range and Aggregate Analytics by Date Range buttons.
- Navigate to Messaging > Campaigns, click View Archived Campaigns, and use the Export Campaign Metrics by Date Range and Aggregate Analytics by Date Range buttons.
Use the following APIs to export individual campaign metrics:
To export experiment metrics:
Use Iterable's web interface to export metrics for individual experiments:
- Navigate to Messaging > Experiments.
- Open an experiment.
- Click Export Table to CSV.
- Save the CSV file to your machine.
Use the following API to export metrics for multiple experiments:
- Pass in multiple experiment IDs, as necessary.
Events (system and custom)
To export a user's events, call the
API. Make sure to specify
Deleting vs forgetting
Deleting a user does not stop the Iterable project from storing future
information it receives about that user. To prevent that from happening, use
API (which also deletes users).
For more information, read Responding to GDPR Requests.
Deleting users with Iterable's API
Iterable cannot recover data associated with deleted users. Before deleting users, consider backing up important data.
Iterable provides APIs for deleting users by email and user ID:
These APIs are rate-limited at at three requests per second. Use them to delete a small number of users. To delete a large number of users, see Deleting users in bulk.
Deleting users in bulk
- Iterable cannot recover data associated with deleted users. Before deleting users, consider backing up important data.
- Use extreme caution when deleting users in bulk. Make sure that the static list used to start the bulk deletion process contains only the users that should be completely deleted from the Iterable project.
The bulk deletion feature deletes all users on a specific static list from an Iterable project. Only users having the project permission User Profiles & Data > Create & Manage Contacts can perform bulk deletions. For more information, read Account Roles and Permissions.
To perform a bulk deletion, follow these steps:
Sign in to your Iterable project with an account that has the User Profiles & Data > Create & Manage Contacts permission.
Navigate to Audience > Lists.
If necessary, create a new static list containing the users you'd like to delete (for more information, read Static and Dynamic Lists Overview). If you already have such a list, move on to the next step.
You cannot perform a bulk deletion with a dynamic list.
Click the list to view its details.
Click Refresh Results to view the users on the list. Double-check that the list contains only users that should be completely deleted from the Iterable project.
Click Other Actions > Delete Contacts From Project.
A Delete Contacts From Project window will appear. Read it careully. If necessary, back up your data before proceeding.
Check the I Understand that Deleted Contact Data... checkbox.
DELETEin the Type DELETE to Proceed input.
If you proceed, all users contained in the list will be completely deleted from the Iterable project. They cannot be recovered.
Click Schedule Deletion.
After you initiate a deletion:
Iterable will eventually delete the users on the list, usually within 24 hours. However, the actual time required to finish the deletion depends on the size of the list and system load. To check a deletion's status, navigate to the Audience > Lists screen and look at the Contacts column for the list. When the delete is done, this column will show 0 (unless more users have been added in the meantime).
If Iterable receives data for a given user for whom you've already initiated a deletion, it will also delete the new data.
If you delete a user who's in a workflow, they'll be removed from that workflow.
Users for whom deletion is pending can still receive messages from campaigns and workflows (until the deletion is complete).
Users added to a list for which a bulk deletion is already in progress will not be deleted.
When performing a bulk deletion, Iterable deletes each user on the deletion list from the Iterable project and from the list itself. However, it does not delete the list.