API Reference: Campaign Duplication API Follow

Overview

This document contains the technical information for using the Duplicate Campaign API.

Please note: Contact our Support team to enable this API for your account.

 

Enterprise Endpoint

https://{your enterprise name}.api.cvtr.io/duplicate-campaign

Headers

Parameter Value
Content-Type application/json
x-api-key Your API key. Contact our support team if you don't have it yet.

 

Request Parameters

Parameter Description
campaignName

<string>

(Required) New campaign name. Example:

"campaignName": "My New Campaign"
campaignType

<integer>

(Required) Numeric ID of the campaign type from the below list:

  1. Cleansing & Validation
  2. Content Syndication
  3. Events & Field Marketing
  4. Email & Direct Outreach
  5. Paid Media (Search, Display, Programmatic)
  6. Partner & Ecosystem
  7. Owned / First-Party Data
  8. Social & Community (including Paid Social)
  9. Other

Example (Direct Outreach):

"campaignType": 4
campaignId

<integer>

(Required) Source campaign ID to duplicate from. Example:

"campaignId": 1234
payout

<string>

(Required) Per action payout amount (CPL Rate). Example:

"payout": "5.50"
startDate

<date string>

(Required) Campaign start date in ISO 8601 (YYYY-MM-DD) format. Example:

"startDate": "2025-10-20"
endDate

<date string>

(Required) Campaign end date in ISO 8601 (YYYY-MM-DD) format. Example:

"endDate": "2026-10-20"
currency

<string>

(Required) Currency code in ISO 4217 format (e.g. USD, GBP, EUR). Example:

"currency": "USD"
leadsRequired

<integer>

(Required) Number of required leads for the campaign. Example:

"leadsRequired": 300
advertiserId

<integer>

ID of an advertiser to assign the campaign to. Default is the advertiser ID of the source campaign. Example:

"advertiserId": 12
accountManager

<string>

Account manager name. Default is the account manager name of the source campaign. Example:

"accountManager": "John Doe"
campaignManager

<string>

Campaign manager name. Default is the campaign manager name of the source campaign. Example:

"campaignManager": "Mary Jane"
testMode

<boolean>

If to enable delivery test mode for the campaign. See this article. Default is false. Example:

"testMode": true
internalOnly

<boolean>

If to mark the campaign as internal. This will exclude campaign data from Business Insights reporting. Default is false. Example:

"internalOnly": true
includePermissions

<boolean>

If to duplicate campaign permissions. Default is false. Example:

"includePermissions": true
includePublisher

<boolean>

If to duplicate publishers. Default is false. Example:

"includePublisher": true
includeCreativeAssets

<boolean>

If to duplicate creative assets. Default is false. Example:

"includeCreativeAssets": true
includeLandingPageForm

<boolean>

If to duplicate landing pages and forms. Default is false. Example:

"includeLandingPageForm": true
includeLinks

<boolean>

If to duplicate tracking links. Default is false. Example:

"includeLinks": true
includePayoutBands

<boolean>

If to duplicate payout bands. Default is false. Example:

"includePayoutBands": true
includeValueTransforms

<boolean>

If to duplicate value transforms. Default is false. Example:

"includeValueTransforms": true
includeCampaignEvents

<boolean>

If to duplicate campaign events. Default is false. Example:

"includeCampaignEvents": true

 

Example request

curl --location 'https://{your enterpise name}.api.cvtr.io/duplicate-campaign' \
--header 'x-api-key: <YourSecretKey>' \
--header 'Content-Type: application/json' \
--data '{
    "campaignName": "My New Campaign",
    "campaignType": 4,
    "campaignId": 1234,
    "payout": "5.50",
    "startDate": "2025-10-20",
    "endDate": "2026-10-20",
    "currency": "USD",
    "advertiserId": 12,
    "leadsRequired": 300,
    "accountManager": "John Doe",
    "campaignManager": "Mary Jane",
    "testMode": true,
    "includePermissions": true,
    "includePublisher": true,
    "includeCreativeAssets": true,
    "includeLandingPageForm": true,
    "includeLinks": true,
    "includePayoutBands": true,
    "includeValueTransforms": true,
    "includeCampaignEvents": true,
    "internalOnly": true
}'

 

Response

Success

HTTP 200

{"message": "Ok"}

Error

API key missing or invalid

HTTP 403

{"message": "Forbidden"}

Required fields missing, wrong JSON field type, malformed JSON

HTTP 400

{"message": "Invalid request body"}

Source campaign not found

HTTP 404

{"message": "Campaign not found"}

Target advertiser not found

HTTP 404

{"message": "Advertiser not found"}

Articles in this section

See more

Related articles