Suppression List
- Arunima Kurup Prasad
Platform URL | https://[enterprise].cvtr.io/v2/campaigns/1986/leads |
|---|---|
API Endpoints | Retrieves/Imports/Removes Suppression Email List: GET/POST/DELETE https://{enterprise}.cvtr.io/api/v4/invalid-emailsRetrieves/Creates/Removes Suppression Name Lists: GET/POST/DELETE https://{enterprise}.cvtr.io/api/v4/invalid-namesRetrieves/Creates/Removes Suppression Telephone Lists: GET/POST/DELETE https://{enterprise}.cvtr.io/api/v4/invalid-telephones |
Epic | |
Document status | REVIEWED |
Document owner | @Danny Hannah @Adam Carter |
Technical writers | @Arunima Kurup Prasad |
Related Content |
Feature Overview
Suppression
Suppression lists allow users to check the leads against the list of values to suppress and reject a lead based on the condition selected. For example, if the user wants to reject leads that have specific email domains, names, telephone numbers, they can set up specific suppression lists and run them for each lead. Leads that match values configured in the suppression list will be rejected.
Suppression Lists set up at an Enterprise level in ‘System' will be applicable to all campaigns created for the enterprise. Campaign specific suppression lists can be created and accessed from the Campaign > Leads page using the 'Suppression List’ button.
It is possible to create two different types of suppression lists at campaign level: Email and Telephone.
1. Email Suppression Lists
List of email addresses may be imported via CSV file in the ‘Email Suppression List’ tab in Campaign > Leads > Suppression List modal. By doing so, any email address/domain in the list will be suppressed and leads containing those email addresses will be invalidated.
The table has the columns: Email: that stores the email address or domain name, Added: that stores the date the entry was created. There is also a column with checkboxes to select multiple entries to perform Delete.
User can search for Email Address and sort them in asc/desc order.
The table also has the option for pagination.
Users can import and delete email suppression lists.
Import via CSV
Clicking on the ‘Import CSV’ button opens the below modal. Clicking on the ‘Download CSV template here’ link on the blue bar downloads a sample template to the user’s machine. The user can then add values to the CSV file and import the CSV file and click Save.
The new email suppression values will be available in the email suppression listing table.
Delete
To delete email suppression values, the user can either select an individual value and click on the Delete button or select multiple values using the corresponding checkboxes and click on the Delete button to delete multiple values at once.
The below confirmation dialog will be shown to the user, upon confirmation of which the selected value(s) will be deleted and removed from the email suppression listing.
2. Telephone Suppression Lists
List of telephone numbers may be imported via CSV file in the ‘Telephone Suppression List’ tab in Campaign > Leads > Suppression List modal. By doing so, any telephone number in the list will be suppressed and leads containing those telephone numbers will be invalidated.
The table has the columns: Telephone: The number to be suppressed, Added: the day the entry was created. There is also a column with checkboxes to select multiple entries to perform Delete.
User can search for telephone number and sort them in asc/desc order.
The table also has the option for pagination.
Users can import and delete telephone number suppression lists.
Import via CSV
Clicking on the ‘Import CSV’ button opens the below modal. Clicking on the ‘Download CSV template here’ link on the blue bar downloads a sample template to the user’s machine. The user can then add values to the CSV file and import the CSV file and click Save.
The new telephone number suppression values will be available in the telephone number suppression listing table
Delete
To delete telephone number suppression values, the user can either select an individual value and click on the Delete button or select multiple values using the corresponding checkboxes and click on the Delete button to delete multiple values at once.
The below confirmation dialog will be shown to the user, upon confirmation of which the selected value(s) will be deleted and removed from the telephone number suppression listing.
Summary
Functionality | User Story | |
|---|---|---|
| 1 | Email Suppression List | Users can see the table listing of all the emails that need to be suppressed |
| 2 | Telephone Suppression List | Users can see the table listing of all the telephone numbers that need to be suppressed |
| 3 | Email Suppression List > Import via CSV | Users can add email addresses to the list by importing CSV file |
| 4 | Telephone Suppression List > Import via CSV | Users can add telephone numbers to the list by importing CSV file |
| 5 | Email Suppression List > Delete | Users can delete email addresses from the suppression list |
| 6 | Telephone Suppression List > Delete | Users can delete telephone numbers from the suppression list |
| 7 | Filter | Users can search for email addresses and telephone numbers using the filter option available on the columns |
| 8 | Sort | Users can sort email addresses and telephone numbers in asc/desc order using the sort option available on the columns |
User Permissions
Only admin and agency users have access to this functionality.