/
Delete, Pause and Duplicate Campaigns

Delete, Pause and Duplicate Campaigns

Platform URL

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

API Endpoints

Pause campaign and Resume campaign

PUT /api/v4/campaigns/{campaignId}

Duplicate campaign

Retrieve currency list

GET /api/v4/currencies?page=1&itemsPerPage=100

POST /api/v4/campaigns/{campaignId}/duplicate

Delete campaign

DELETE /api/v4/campaigns/{campaignId}

Epic

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

Document status

FOR REVIEW

Document owner

@Danny Hannah @Adam Carter

Technical writers

@Arunima Kurup Prasad

Related Content

Import Campaign Setup

Feature Overview

In addition to ‘Create Campaign’ and ‘Import Campaign’ options, the Convertr platform also allows users to ‘Duplicate’ campaigns, ‘Pause’ campaigns and also ‘Delete Campaigns’.

These options are available in the campaign settings screen by navigating to Campaign > Admin > Setup.

  1. Delete

If a campaign is unwanted/incorrect, an Admin or Agency user can delete the campaign by selecting the campaign and navigating to Admin > Setup and clicking on the ‘Delete’ button.

The user will be shown a confirmation dialog, upon acceptance of which the campaign and all its associated details will be deleted.

  1. Pause

It is possible to pause campaigns so that leads will not be delivered to the campaign during this period. When the pause button is clicked, the below dialog box is shown. Here the user must enter the date and time from which the campaign must be paused.

Once this is configured and ‘Pause’ button is clicked, the user will be shown the below information.

The campaign will be paused on the date and time configured at the time of pausing, until the campaign will be active. Paused campaigns will have the status ‘Paused’ and will move to the Inactive campaigns tab.

Once the ‘Pause’ button is clicked and user configures the date/time for pausing, the ‘Pause’ button will be changed to ‘Resume’ button.

The user can resume the paused campaign at any time by clicking the 'Resume' button.

On clicking the ‘Resume’ button, the user is shown a confirmation dialog, upon confirmation of which the campaign will be resumed immediately.

The below message will be displayed to the user and the campaign will move back to the Active campaigns listing tab.

  1. Duplicate

It is possible to make a duplicate of an existing campaign by clicking the ‘Duplicate’ button.

The user must fill in the details in the below modal.

The ‘Advertiser’ will be the same as the campaign being duplicated and cannot be changed. The user must enter other details such as:

  • Campaign name

  • Leads Required

  • Currency

  • Per Action payout amount

  • Start Date and End Date

Other configurations that the user may choose to duplicate are:

  • Publishers: If checkbox is ticked, all publishers from the original campaign will be copied over

  • Payout Bands: If checkbox is ticked, any payout bands available on the original campaign will be copied over. If this is selected, ‘Publishers’ will be auto selected and cannot be unchecked unless Payout bands is unchecked.

  • Permissions: All permissions from the original campaign will be copied over as the campaign belongs to the same advertiser

  • Landing Pages and Forms: These may be copied over from the original campaign

  • Creative Assets: These may be copied over from the original campaign

  • Links: These may be copied over from the original campaign

  • Value Transforms: These may be copied over from the original campaign

  • Scheduled Delivery: If Scheduled Delivery is enabled on the original campaign, the same may be copied over to the duplicate campaign if the checkbox is ticked. If Scheduled Delivery is enabled, then the publishers and payout bands will also be auto checked and cannot be unchecked unless Scheduled Delivery is unchecked.

Once all mandatory fields are entered and configurations to duplicate are selected, the user can save the campaign by clicking the Save button. The below message will be shown and the duplicate campaign will be available in the dashboard under Active campaigns or Inactive campaigns based on whether the Start date is a past/current date or a future date.

Further changes to the campaign configurations can be made by selecting the campaign and navigating to Admin > Setup and updating the campaign settings.

Summary

Summarise the functionalities in a table

Functionality

User Story

Functionality

User Story

1

Delete

Admin and Agency users can delete campaigns that are no longer required

2

Pause

Admin and Agency users can pause campaigns so that leads are not delivered to the campaign from the configured date/time

3

Duplicate

Admin and Agency users duplicate existing campaigns under the same advertiser and can copy over configurations like publishers, payout bands, scheduled delivery, forms, value transforms etc.

 User Permissions

Only Admin and Agency users have access to this section of the platform.

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

Related content

Import Campaign
Import Campaign
More like this
Campaign Listing
Campaign Listing
More like this
Setup
More like this
Create Campaign
Create Campaign
More like this
Quick Campaign
Quick Campaign
More like this
Associate Form and 'Save As New'
Associate Form and 'Save As New'
More like this