/
Validation Lists

Validation Lists

 

Platform URL

https://[enterprise].cvtr.io/v2/system/validation-list

Epic

https://convertr.atlassian.net/browse/DAS-334

API Endpoints

Download validation list

POST https://{enterprise}.cvtr.io/api/v4/suppression-list-download

Show/Add/Remove/Edit validation list

GET/POST/DELETE/PUT https://{enterprise}.cvtr.io/api/v4/suppression-lists

Add/Edit/Remove value to/from validation list

POST/PUT/DELETE https://{enterprise}.cvtr.io/api/v4/suppression-list-values

Retrieve validation list values

GET https://{enterprise}.cvtr.io/api/v4/suppression-list-value

Import values to validation list

POST

https://{enterprise}.cvtr.io/api/v4/suppression-list-values/import

 

Document status

Reviewed

Document owner

@Danny Hannah

Technical writers

@Arunima Kurup Prasad @Anu Kalangi

Related Content

Advertisers Validation Lists

Feature Overview

Validation Lists are a flexible way to create a type of list which can be used to validate information against. This can be a suppression list (a list of values to exclude against), white or black list, or a key account list (leads have to match against) and commonly a pick list (ensuring a lead value matches a predefined set of values).

Common examples of a validation list tend to be company names that a client wants to target and will only validate leads when the company name matches a value within the list - e.g. As a user I only want to have leads from fortune 500 companies.

We have 2 types of Validation lists. One that is global on the enterprise and can be used by all Advertiser campaigns: ‘System > Validation Lists’. The other type is associated to a specific Advertiser and only available for use on their campaigns: 'Advertisers > Validation Lists' (See Related Content in the table above)

Functionalities

Admin and Agency users can create and manage global validation lists by navigating to System > Validation Lists. Global validation lists created are listed in a table that has the following columns: ID, Name, Value Count and Actions.

  • ID: Unique ID to identify the validation list. The column also provides an option to search by validation list ID and sort the ID in asc/desc order.

  • Name: Name of the validation list. It is possible for the user to edit and save the name in line. The column also provides an option to search by the name validation list and sort the name in asc/desc order.

  • Value Count: Shows the number of values in the validation list.

  • Actions: This column contains the Add/Edit and Download buttons.

The table also has pagination and an option to download the page contents as a CSV file.

 

Add Validation Lists

Above the validation list table is available an Add button using which the user can create new validation lists. Clicking on the Add button opens a modal where the user must enter the name of the validation list.

 

Clicking on Save, opens a ‘Add Validation List’ modal with 2 tabs: ‘Add Values’, ‘Import Values’.

  • Add Value: Using the ‘New Value’ text field and ‘Add’ button, new values may be added to the validation list. Values added this way will be shown as a table with fields: ID and Value.

  • Import Value: A blue banner provides a link to download a sample CSV format in which the values must be imported to the validation list. Once the CSV file has been created in the required format, the user can browse and import the file in this tab. Imported values will be shown as a table in the ‘Add Value’ tab with fields: ID and Value.

The user can remove individual/multiple values from the validation list by clicking the corresponding checkbox and clicking on the ‘Remove’ button. A confirmation dialog box is shown to the user for confirming the delete action. Using the ‘Remove All' button, all values in the validation list may be deleted by confirming the action in the dialog box.

 

Delete Validation Lists

Validation lists can be deleted by clicking on the ‘Delete’ button available above the validation lists listing table. The user may select individual or multiple validation lists for deletion. On clicking Delete, a confirmation dialog is shown to the user. Upon confirmation, the validation list will be deleted only if the selected validation list is not assigned to any processr jobs. If the validation list is used in any campaign’s processr job, an error message will be shown to the user.

If the validation list is not used in any campaign, it will be removed from the listing.

Add/Edit values

User can add values to/edit existing values on validation lists by clicking on the Add/Edit button available against each validation list. It opens the ‘Edit Values’ modal and contains 2 tabs: ‘Add Values’ and ‘Import Values'. The working is the same as the ‘Add Values’ modal.

 

Download validation list values

Each individual validation list may be downloaded by clicking on the Download button available against each validation list. An email will be sent to the user when the download is complete; the values of the validation list will be downloaded in CSV format.

Validation List Processr Job

It is possible to cross reference a lead field value against the values of a validation list and decide whether to perform an exact match on the values or use a partial match or check the list strictly or loosely, using case sensitivity. The user can choose whether matching a value is either a good thing or bad thing and pass / fail accordingly.

 User Permissions

Only Admin and Agency users have access to System validation lists

https://docs.google.com/spreadsheets/d/1i4qTTKkC3rF3EyEOh2585ktDDGge0L0IMVDNCwriFR0/edit#gid=67588165

Related content

Advertisers Validation Lists
Advertisers Validation Lists
More like this
Suppression
Suppression
More like this
Publishers
Read with this
Suppression List
Suppression List
More like this
System Audit
System Audit
Read with this
Validation Lists
Validation Lists
More like this