Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 13 Next »

Platform URL

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

Epic

DAS-334 - Getting issue details... STATUS

API Endpoints

Download validation list

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

Show/Add/Remove validation list

GET/POST/DELETE 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 https://{enterprise}.cvtr.io/api/v4/suppression-list-values/import

Document status

DRAFT

Document owner

Danny Hannah

Technical writers

Danny Hannah Arunima Kurup Prasad

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

global validation lists: I should be able to create, edit and delete validation lists on a global level. I should be able to create many validation lists globally.

I should be able to set a “name” for my validation list so I can determine it’s contents.

As per the global lists, I should be able to create many validations lists for a single advertiser.

Allow advertisers to create “Private” validation lists : create my own validation list and mark it as private.

The role of the “private” validation list 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.

As a publisher user, it would be useful for me to be able to download the contents of a validation list so I can ensure I am meeting the requirements of the campaign.

As an agency user, I should be able to choose which validation lists to show to publishers. I should not be able to expose private validation lists.

Import using CSV: As a user of the validation lists feature, I would expect to be able to import large CSV files of values for a validation list - this should be available for both adding and editing validation lists. I would also expect to have some sort of template or guide as to what format to import the values in.

Validation on deletion

when trying to delete a validation list the platform will prompt for validation confirming that validation isn't assigned on and campaigns.

If so the validation list will need to be removed from a campaign before you can delete the validation list.

Validation List Processr Job

As a user that sets up or manages a campaign, I would like to be able to cross reference a lead field value against the values of my validation list.

I should be able to decide whether to perform an exact match on the values or use a partial match.

I should also be able to choose whether matching a value is either a good thing or bad thing and pass / fail accordingly.

I should also be able to configure a field name which contains multiple values and ensure they are all in a single validation list. For example I might have a field of subscribed_email_lists which has a value of main_list,priority_list, I would like to check that both main_list and priority_list are contained in my validation list.

I should also be able to choose whether to check the list strictly or loosely, using case sensitivity.

Finally, I should be able to optionally bypass the check if I have a blank|empty value for my chosen field. This would be for us to handle fields that are optional, but if populated check against the validation lists values.

\uD83D\uDDD2 User Permissions

Only Admin and Agency users have access to System validation lists

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

  • No labels