Suppression
- Arunima Kurup Prasad
- Anu Kalangi
- Muge Budak
Platform URL | |
|---|---|
API Endpoints | Retrieves/Creates/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/telephonesImport Suppression Email List: Import Suppression Name List: Import Suppression Telephone List: |
Epic | |
Document status | REVIEWED |
Document owner | @Danny Hannah @Adam Carter |
Technical writers | @Anu Kalangi @Arunima Kurup Prasad @Muge Budak |
Related Content |
Feature Overview
Suppression
Suppression lists or Validation lists allow users to check the leads against the list of values to either target or suppress and pass/reject a lead based on the condition selected. For example, if the user is targeting a list of specific companies in a campaign, the user can set up a validation list to ensure that the lead data contains only the exact values required.
Suppression/Validation Lists can be set up in two areas:
System Level: Lists applied at this level will be accessible across all campaigns in the enterprise.
Advertiser Level: Lists applied at this level will only be available to campaigns set up under this advertiser. Please refer the documentation mentioned in ‘Related Content’ above
Suppression lists at the enterprise level may be created and maintained only by admin users by navigating to System > Suppression.
There are three different types of suppression lists that the admin user can add to the platform; Email, Name and Telephone.
1. Email Suppression Lists
List of email addresses may be added or imported via CSV file in the Email tab in System > Suppression. By doing so, any email address in the list will be suppressed and leads containing those email addresses will be invalidated.
The table has the columns: ID that stores the unique id of an email entry and Email Address that stores the email address or domain name. There is also a column with checkboxes to select multiple entries to perform Delete.
User can search for ID and sort them in asc/desc order.
User can search for Email Address and sort them in asc/desc order.
The table also has the option for pagination.
Users can add, import, and delete email suppression lists.
Add
Clicking on the ‘Add Email’ button opens the below modal. The user must enter the email address/domain and click Save. The new email suppression will be available in the email suppression listing table.
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. Name Suppression Lists
List of names may be added or imported via CSV file in the Name tab in System > Suppression. By doing so, any names in the list will be suppressed and leads containing those names will be invalidated.
The table has the columns: ID, First Name and Last Name. There is also a column with checkboxes to select multiple entries to perform Delete.
The ‘ID’ column stores the unique id of a name entry
‘First Name’ stores the first name that needs to be suppressed
‘Last Name’ stores the last name that needs to be suppressed
User can search for ID and sort them in asc/desc order.
User can search for First Name and Last Name and sort them in asc/desc order.
The table also has the option for pagination.
Users can add, import, and delete name suppression lists.
Add
Clicking on the ‘Add Name’ button opens the below modal. The user must enter the First Name and Last Name and click Save. The new name suppression will be available in the name suppression listing table.
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 name suppression values will be available in the name suppression listing table.
Delete
To delete name 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 name suppression listing.
3. Telephone Suppression Lists
List of telephone numbers may be added or imported via CSV file in the Telephone tab in System > Suppression. 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: ID and Telephone Number. There is also a column with checkboxes to select multiple entries to perform Delete.
The ‘ID’ column stores the unique id of a telephone number entry
'Telephone Number' stores the telephone number that needs to be suppressed
User can search for ID and sort them in asc/desc order.
User can search for telephone number and sort them in asc/desc order.
The table also has the option for pagination.
Users can add, import, and delete telephone number suppression lists.
Add
Clicking on the ‘Add Telephone’ button opens the below modal. The user must enter the Telephone Number and click Save. The new telephone number suppression will be available in the telephone number suppression listing table.
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 | Name Suppression List | Users can see the table listing of all the first and last names that need to be suppressed |
| 3 | Telephone Suppression List | Users can see the table listing of all the telephone numbers that need to be suppressed |
| 4 | Email Suppression List > Add | Users can add emails to the list via the Add Email Address modal |
| 5 | Name Suppression List > Add | Users can add names to the list via the Add Name modal |
| 6 | Telephone Suppression List > Add | Users can add names to the list by importing CSV file |
| 7 | Email Suppression List > Import via CSV | Users can add email addresses to the list by importing CSV file |
| 8 | Name Suppression List > Import via CSV | Users can add telephone numbers to the list by importing CSV file |
| 9 | Telephone Suppression List > Import via CSV | Users can add telephone numbers to the list by importing CSV file |
| 10 | Email Suppression List > Delete | Users can delete email addresses from the suppression list |
| 11 | Name Suppression List > Delete | Users can delete names from the suppression list |
| 12 | Telephone Suppression List > Delete | Users can delete telephone numbers from the suppression list |
| 13 | Filter | Users can search for names, email addresses and telephone numbers using the filter option available on the columns |
| 14 | Sort | Users can sort names, email addresses and telephone numbers in asc/desc order using the sort option available on the columns |
User Permissions
Only admin users have access to System > Suppression