/
Import Leads

Import Leads

Platform URL

https://[enterprise].cvtr.io/v2/campaigns/{campaignId}/leads

API Endpoints

Load the previously saved form templates

GET /api/v4/advertiser-lead-import-maps

Load the forms associated with the campaign

GET /api/v4/forms

Load the publishers assigned t the campaign

GET api/v4/campaign-publishers

Load the tracking links on the campaign

GET api/v4/campaign-links

Load the mapping for the selected form

GET api/v4/leads-import/form/{formId}/campaign/{campaignId}/form-mapping

Check if authorisation is required- if publisher over delivery, this will be true, else false.

POST api/v4/leads-import/is-authorisation-required

Import the leads to the campaign

POST api/v4/leads-import

Epic

Epic not found. Related Jira ticket: https://convertr.atlassian.net/browse/CP-591

Document status

REVIEWED

Document owner

@Danny Hannah @Adam Carter

Technical writers

@Arunima Kurup Prasad

Related Content

Campaign Publishers

Feature Overview

Importing leads into a campaign is one of the primary functionalities of the Convertr platform. Once a campaign is created by an agency and the various configurations such as publisher bands, processr jobs, value transforms, suppression lists and validation lists have been set up, the next step is to assign publishers to the campaign, who will import leads into the campaign.

Admin users, agency users, call centre users and publishers, after having signed the contract, can import leads into a campaign.

Admin users, agency users and call centre users can use the ‘Import’ button available on Campaign > Leads page to import leads into the campaign.

Publisher users have an ‘Import’ icon against each campaign they are assigned to, on their dashboard (see Importing leads to a campaign section in Publishers )

Leads can be imported at a campaign level only, i.e. different leads cannot be imported to different campaigns at once.

Lead import involves the below 4 steps:

  1. Upload

  2. Setup

  3. Mapping

  4. Preview

1.Upload

Clicking on the ‘Import’ button will open a ‘Import Leads’ modal which allows the user to upload a CSV file containing lead data. A sample file is available for download in the link in the blue banner in the modal.

Below is a sample CSV file template for lead import

All forms associated with the campaign are available in the ‘Select a form’ dropdown. The user must select the appropriate form and upload the CSV file. Different delimiters are supported in the CSV file- comma, semicolon, tab, pipe. The appropriate delimiter may be selected and the user can proceed to the next step. The user will be able to proceed to the next step only if they have selected the form and uploaded a CSV file.

2. Setup

On the next step, which is ‘Setup’, the user can select a publisher from the ‘Publisher’ dropdown if they want the lead(s) to be associated with a publisher. If a publisher is selected, the imported leads will have the publisher’s name under ‘Lead Generator’ column and will be billable for the publisher if valid and within delivery cap.

This is an optional value. If no publisher is selected, the leads will not have a lead generator associated and will not be considered for any publisher’s cap.

They can also provide an optional tracking link. Select a tracking link helps to identify the channel the imported leads will be applied to. If left unset, the channel for each imported lead will be empty.

There is also an option ‘Replacement’ which may be set if the leads being imported are replacement leads. By enabling this, within reporting it will be noted that the imported leads are replacing previously returned lead(s) as 'make good'. This has no impact on processing and is used for reporting purposes only.

3. Mapping

On the next step, ‘Mapping’, the user must map the form fields with the fields on the CSV file. If the mapping is incorrect, it can lead to incorrect data being mapped to form fields and can make a lead invalid.

Save as New Template

The Mapping step provides a ‘Save as new template’ checkbox option which the user can select to create templates.

This allows the users to save the mapping setup as a new template for future imports. After entering the fields, the user can check the checkbox, enter the name for the new mapping template and click the 'Save' button. This will create and save the new template and simultaneously import the leads to the campaign.

Managing Templates

Saved templates will be available in the ‘Mapping Template’ dropdown in the Mapping step. Users can manage previously saved mapping templates. Users can select a template from the dropdown and click on ‘Load’ button to load the template, as shown below.

If the user wishes to reset the mapping, they can do so by clicking on the ‘Reset’ button.

If the user wishes to delete a mapping template, they can do so by selecting the template and then clicking on the ‘Delete’ button.

When a template is deleted, the user gets a snack bar notification and the template will no longer be listed in the Mapping Template dropdown.

Mapping can be done on a field to field basis or, by selecting a previously saved template. While importing leads, user can select from previously saved templates from the dropdown. If no template is available, they can use the ‘Save as new template’ checkbox to save the mapping as a new template for future use on the campaign.

The user can proceed to the next step only if they have mapped all fields.

4. Preview

On the final step, ‘Preview’, the user can preview their import (10 rows of data) and opt-in that the data was captured lawfully. This helps the user to verify the lead data and confirm they have mapped the fields correctly. There is also a banner that shows the number of leads that will be imported.

They can always go back to a previous step to edit any information. After confirming the import action, the 'Save' button will be enabled and the user can click it to import the leads to the campaign.

Summary

Summarise the functionalities in a table

Functionality

User Story

Functionality

User Story

1

Upload

Admin, Agency users and call centre users can download a sample CSV file with the fields required for the campaign and then upload a completed CSV file with lead details

2

Setup

Admin, Agency users and call centre users can select the publisher, tracking link for the set of leads and can also mark leads as replacement

3

Mapping

Admin, Agency users and call centre users can map form fields to CSV file’s fields and also save templates or reuse templates previously saved on the campaign

4

Preview

Admin, Agency users and call centre users can see a preview of 5 records that will be imported to the campaign so that they can confirm the data and can go to previous steps to edit the data

 User Permissions

Admin, Agency users and call centre users can import leads to a campaign.

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

Related content

Input Types- ESP Lookups - Selligent
Input Types- ESP Lookups - Selligent
Read with this
POST Leads via Campaign Web-hook (Global Forms)
POST Leads via Campaign Web-hook (Global Forms)
More like this
POST Leads via Campaign Web-hook v1
POST Leads via Campaign Web-hook v1
More like this
POST Leads via Campaign Web-hook v2
POST Leads via Campaign Web-hook v2
More like this
Import Campaign
Import Campaign
More like this
Export Leads
Export Leads
More like this