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.
campaignId

<integer>

(Required) Source campaign ID to duplicate from.
payout

<string>

(Required) Per action payout amount (CPL Rate).
startDate

<date string>

(Required) Campaign start date.
endDate

<date string>

(Required) Campaign end date.
currency

<string>

(Required) Currency code (ISO 4217).
leadsRequired

<integer>

(Required) Number of required leads for the campaign.
advertiserId

<integer>

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

<string>

Account manager name.
campaignManager

<string>

Campaign manager name.
testMode

<boolean>

If to enable test mode for the campaign. See https://support.convertrmedia.com/hc/en-us/articles/205477592-Test-Mode. Default is false.
internalOnly

<boolean>

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

<boolean>

If to duplicate campaign permissions. Default is false.
includePublisher

<boolean>

If to duplicate publishers. Default is false.
includeCreativeAssets

<boolean>

If to duplicate creative assets. Default is false.
includeLandingPageForm

<boolean>

If to duplicate landing pages and forms. Default is false.
includeLinks

<boolean>

If to duplicate tracking links. Default is false.
includePayoutBands

<boolean>

If to duplicate payout bands. Default is false.
includeValueTransforms

<boolean>

If to duplicate value transforms. Default is false.

Example request

curl --location 'https://{your enterpise name}.api.cvtr.io/{stage}/duplicate-campaign' \
--header 'x-api-key: YourSecretKey' \
--header 'Content-Type: application/json' \
--data '{
    "campaignName": "nameTest",
    "campaignId": 1,
    "payout": "15",
    "startDate": "2025-01-01",
    "endDate": "2025-12-31",
    "currency": "USD",
    "advertiserId": 10,
    "leadsRequired": 100,
    "accountManager": "Steven Pauler",
    "campaignManager": "Joe Noble",
    "testMode": true,
    "includePermissions": true,
    "includePublisher": true,
    "includeCreativeAssets": true,
    "includeLandingPageForm": true,
    "includeLinks": true,
    "includePayoutBands": true,
    "includeValueTransforms": 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