Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Page Properties

Platform URL

https://[enterprise].cvtr.io/v2/advertisers/[advertiserId]/validation-lists

API Endpoints

Retrieves Suppression/Validation Lists:

Code Block
GET https://{enterprise}.cvtr.io/api/v4/suppression-lists

Creates Suppression/Validation Lists:

Code Block
POST https://{enterprise}.cvtr.io/api/v4/suppression-lists

Retrieves Suppression/Validation Values:

Code Block
GET https://{enterprise}.cvtr.io/api/v4/suppression-list-values

Creates Suppression/Validation Values:

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

Downloads Suppression/Validation Values:

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

Upload CSV file containing Suppression/Validation Values:

Code Block
https://{enterprise}.cvtr.io/api/v4/files/csv

Import Suppression/Validation Values:

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

Retrieves/Removes/Replaces a Suppression/Validation Values:

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

Epic

Jira Legacy
serverSystem JIRA
serverId47839f05-61cf-355f-8da7-a069f30ee70e
keyDAS-14

Document status

Status

VALID

colourGreen
titleREVIEWED

Document owner

Adam Carter

Technical Writers

Anu Kalangi Muge Budak Arunima Kurup Prasad

Related Content

https://convertr.atlassian.net/l/cp/aGdPsUqe

...

Validation Lists

Validation lists allows 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.

Validation Lists can be set up in two areas:

  1. System Level

...

  1. : Lists applied at this level will be accessible across all campaigns in your enterprise. Please refer the documentation mentioned in ‘Related Content’ above

  2. Advertiser Level

...

  1. : Lists applied at this level will only be available to campaigns set up under this advertiser.

Setting Up Validation Lists At An Advertiser Level

Click Add

When adding a entry to the validation list, user enter the following fields and clicks Save

By clicking on the ‘View’ button or on the ‘Company Name’ hyperlink on the Advertiser listing page, the user will be able to see the Validation Lists menu, based on their user role.

The page lists validation lists configured for the advertiser. Users have the option to perform search on some of the columns. There is also a ‘download’ icon at the bottom of the table which will download the contents of the table as a CSV file.

...

The Add button opens a modal as shown below. Here the user must provide a name for the validation list and specify if it should be a private list.

...

Name

Required

Notes

Name

(tick)

Enter the validation list name

Private Privatise

(tick)

Private Privatise toggle affects the view of the list for any Agency type users on your platform. If set to Private, Agency users will not be able to see the values that are added to the list, or make any changes to it. The role of the “private” private validation list lists is to allow the advertiser to upload potentially sensitive information without exposing it to Agency or Publisher user types.

Admin + Super Admin users should still be able to see private validations lists.

Clicking on Save will open an Add Validation List modal where a modal called ‘Add Validation List’. Here, the user can either add values or import values into the list.

Add Values

User can add values by entering the details in ‘New Value’ and clicking on ‘Add’.

...

Import Values

If the user chooses to import values to the list, they can do so by selecting the ‘Import Values’ tab which will allow the user to upload a CSV file containing the values. Sample CSV file for reference can be downloaded by clicking on the link in the blue banner.

...

Values added/imported will be listed as shown below.

...

...

Users can remove individual values from the list by checking the corresponding checkbox and clicking on ‘Remove’ button. Alternately, the user can remove all values from the list by clicking on the ‘Remove All’ button.

Add/Edit

Existing validation lists may be edited using the Add/Edit button available on the the listing table.

...

Download

Clicking on the Download button will make the validation list available under Exports option. User can then download the list to their environment.

...

\uD83D\uDDD2 User Permissions

The users should have access to the advertisers to be able to view the validation listsAdmin users, agency users and advertiser users associated with the advertiser can access this tab.

https://docs.google.com/spreadsheets/d/1i4qTTKkC3rF3EyEOh2585ktDDGge0L0IMVDNCwriFR0/edit#gid=1710197291 Connect to preview