Versions Compared

Key

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

Platform URL

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

API Endpoints

Load Form

GET /api/v4/forms

Load Mapping

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

Upload CSV file

POST api/v4/files/csv

Bulk Edit of Leads

POST /api/v4/bulk-edits

Epic

Jira Legacy
serverSystem JIRA
serverId47839f05-61cf-355f-8da7-a069f30ee70e
keyDASH-322
Jira Legacy
serverSystem JIRA
serverId47839f05-61cf-355f-8da7-a069f30ee70e
keyDAS-2021

Document status

Status
titleDRAFT

Document owner

Danny Hannah Adam Carter

Technical writers

Arunima Kurup Prasad

Related Content

Campaign > Leads

🏠 Feature Overview

Like the Global leads page, the The Campaign > Leads page also has a Flag/manage ‘Bulk Edit’ option that allows admin users and agency users to flag leads as Valid/Invalid/Test and to manage (mark as delivered, reprocess, delete etc.) leads, within the campaign.

This Flag/Manage functionality enables the user to manually update the lead status.

The option is permitted users to edit multiple undelivered leads within the campaign. This option enables users to edit undelivered leads to make them valid rather than having to resend leads to the campaign.

E.g. If the email address of certain leads need to be updated, the ‘Bulk Edit’ option allows the user to update only this value for multiple leads without having to delete and upload the leads again.

The option to ‘Bulk Edit’ leads will be available only if the below campaign configuration is enabled.

...

If ‘Bulk Edit Data’ option is enabled on the campaign, ‘Bulk Edit’ button will be available just above the leads listing table.Flagging/Managing

...

Bulk Edit of leads involves 3 steps:

  1. Leads selectionUploadType selection

  2. Mapping

  3. ProcessingPreview

Step 1: LeadsUpload

This step involves selecting the leads for actioning. The user can select leads in multiple ways:

i. User can use the checkboxes available against each lead to select the lead, as shown below

...

ii. User can type in the lead ids in the text area provided under ‘LEAD ID(S)’

iii. User can import leads via CSV file using the Import icon, shown below

uploading a CSV files consisting of the leads to bulk edit. Clicking the ‘Bulk Edit’ button opens the ‘Bulk Edit’ modal as shown below. The blue banner provides a link to the zendesk article that explains how the CSV file may be generated. The CSV file should contain only the leads that need to be edited.

...

The user must select a form (forms associated with the campaign will be available in the dropdown) that can be mapped to the CSV file being uploaded.

The ‘Reprocessing' toggle allows the user to choose to reprocess/ not reprocess the edited leads. If the toggle is enabled, the edited leads will be automatically reprocessed (Please refer Reprocess Leads section). If the toggle is disabled, the leads will not be reprocessed and user can manually reprocess leads, if they wish.

The user can then upload the CSV file using the ‘browse files’ option or by dragging and dropping the file into the drop box.

...

The ‘Next’ button will be enabled only if a CSV file is uploaded and a form is selected.

Step 2: Mapping

On this step, the user must map the form fields to the fields in the CSV file. ‘Form Fields’ are available on the left column and ‘CSV Mapping Field’ are available on the right.

‘Lead Id’ is mandatory as this is the field that uniquely identifies the lead to be edited. This field should ALWAYS be mapped to the column that corresponds to the lead id, in the CSV file. If the lead id field is not mapped correctly, bulk edit will not work.

Next, only the fields that require update need to be mapped to the form fields. If a field should remain unchanged, it should be mapped as ‘Do not change’ in the dropdown.

In the below example, only the ‘Lead Id’ and ‘Email’ fields are mapped, the remaining fields are mapped as ‘Do not change’. This means, only the Email field will be updated for the uploaded leads, the rest of the fields will remain unchanged.

...

Clicking on the ‘Next’ button takes the user to the next step - ‘Preview’

Step 3: Preview

The next step is ‘Preview’ where the user is shown a preview of 5 leads that will be updated. A yellow banner also shows the total number of leads that will be edited. If any change is required, the user can go back to the previous steps to upload a different CSV file or map the fields differently.

...

The ‘Save’ button will be enabled only if the user selects the checkbox to agree to the conditions mentioned.

The user must then confirm their choice by entering the number of leads that will be updated, as shown in the dialog below.

...

Clicking on ‘Yes’ will initiate bulk edit on the uploaded leads and the user is shown a confirmation message.

...

User Permissions- Publisher view

Tech dashboard config

Email sent

Lead view notes tab

\uD83D\uDDD2 Summary

Summarise the functionalities in a table

Functionality

User Story

1

Bulk Edit

\uD83D\uDDD2 User Permissions

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

...

Requirement

...

User Story

...

Importance

...

Jira Issue

...

Notes

...

Bulk Edit

...

As an admin or agency user they will need to have the ability to perform all of the above action 1-6 within a bulk action. The user will be able to input a list of lead id(s) (separated by a semicolon) then select the action they wish to perform in bulk.

...