Versions Compared

Key

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

Platform URL

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

API Endpoints

Metrics tab

Retrieve country list

GET /api/v4/countries?itemsPerPage=100&page=?

Retrieve categories list

GET /api/v4/subcategories?itemsPerPage=100&locales.language.id=1

Financials tab

Retrieve currency list

GET /api/v4/currencies

Permissions tab

Retrieve user permissions and users

GET /api/v4/campaign-permissions

GET /api/v4/users

'Grant All'

POST /api/v4/campaigns/{campaignId}/grant-campaign-permissions-for-all-linked-users

Revoke user permissions

DELETE /api/v4/campaign-permissions/{permissionId}

Advanced tab

Retrieve processr jobs and suppression lists

GET /api/v4/campaign-processr-jobs

GET /api/v4/suppression-lists

Metadata tab

Retrieve metadata fields

GET /api/v4/campaign-data-fields?itemsPerPage=100&page=?

Update value for metadata

PUT /api/v4/campaigns/{campaignId}

SAVE campaign settings

PUT /api/v4/campaigns/{campaignId}

GET /api/v4/campaigns/{campaignId}

Epic

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

Document status

Status
colourPurpleGreen
titleIN PROGRESSAPPROVED

Document owner

Danny Hannah Adam Carter

Technical writers

Arunima Kurup Prasad Barnaby Murtagh (Unlicensed)

Related Content

Create Campaign Delete, Pause and Duplicate Campaigns

🏠 Feature Overview

Any changes to the campaign configuration after it is created, can be done by the Admin/Agency users on the ‘Campaign Settings’ section. This is available in Setup under the Campaign > Admin menu.

...

Field Name

Editable

Notes

Enable Realtime Delivery

(tick)

Same as in create campaign flow

Score Based Routing

(tick)

Whether leads should be delivered to different endpoints integrations based on lead score

Value Based Routing

(tick)

Whether leads should be delivered to different endpoints integrations based on a value on the lead

Call Centre Services

(tick)

Same as in create campaign flow

Welcome Email

(tick)

Whether a welcome email should be sent to publisher when assigned

Double Optin

(tick)

Same as in create campaign flow > Tracking tab

Send Media Kit

(tick)

Whether media kit should be sent to publisher when assigned

Hold Publisher Over delivery

(tick)

Whether leads from a publisher should be held without integrating, if they exceed the publisher cap configured

Lead Process Delay

(tick)

Whether a delay (in minutes) should be set for processing leads

Unavailable Campaign Logic

(tick)

Same as the field in ‘Metrics’ tab in create campaign flow

Redirect URL

(tick)To be filled in if ‘Unavailable Campaign Logic’ is set to ‘Redirect to URL’

Same as in create campaign flow > Metrics tab

End Date Extension

(tick)

Same as the field in ‘Metrics’ tab in create campaign flow

Stale Leads Threshold

(tick)

The minimum number of days after which a lead will be marked as stale/invalid, if undelivered

vi. Advanced

The Advanced tab provides additional configurations for the campaign which are not available in the create campaign workflow.

...

The configurations and their description are given below:

Field Name

Notes

Publisher Notes

vii. Metadata

...

Any notes that the publisher must see when they are in the campaign can be configured here

Campaign API Key

Non editable API key which functions as an access token for the duration of the campaign. Publishers deliver leads to the platform using a Campaign webhook, which allows them to post data to the campaign using the Campaign API key.

Publisher Names

Test Mode

If this is enabled, leads in the campaign will be delivered to integrations regardless of their QA status but they will not be billable. This will not work if routing is enabled on the campaign.

Publisher Contract Auto Signing

If this is enabled, publisher contracts will be automatically signed and publisher media kits will not be sent to the publishers.

Manual Score

If this is selected, we can manually set score for leads to pass in the 'Minimum Lead Quality Score'.

Image Added

Any leads that have a score above this value will be marked a valid.

Set ‘Returned’ Flag Reason

If enabled, for Convertr Connect integrations, if leads marked as invalid, this will set 'Returned' as the default reason at the receiving enterprise.

Exclude from Business Insights

If enabled, this campaign will not be included in Enterprise > Business Insights

vii. Metadata

The final tab in campaign settings is the Metadata tab which will be available only if metadata is configured in Enterprise > Metadata.

On this tab, user can configure the values for ‘Metadata’ fields configured in Enterprise > Metadata.

...

If values are configured, these will be available in campaign level and will be available for reporting in Report Builder and Campaign Lead Export.

\uD83D\uDDD2 Summary

Summarise the functionalities in a table

Functionality

User Story

1

User EventsCampaign Setup

Admin and Agency users can see the campaign details, make changes to some of changes on the fields and configure additional campaign , such as processr jobs added/removed, job score changes, campaign date changes, publisher associations etc.

2

Conversions

Admin and Agency users can see details of leads created via tracking links

3

Events

Admin and Agency users can see details of events triggered via tracking eventssettings related to delivery, metadata etc.

\uD83D\uDDD2 User Permissions

...