/

Browse the help center

Copy or move campaign

Copies or moves a campaign to an advertiser (the same or another one).

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/campaign/{campaignId}/{operation}/{advertiserId}.do

Copies or moves a campaign to an advertiser (the same or another one). COPY creates copyCount (1 to 20; anything else is a 400 naming the limit) new campaigns and returns their IDs in 'created' and, in 'copies', each copy's id, name and whether it starts active. A copy is named after the optional 'name' - the first copy takes it as given, later ones get ' 2', ' 3'... appended - or, without 'name', '<name>_copy' / '<name>_copy(N)' when the target advertiser already has a campaign of the source's name, and the source's own name otherwise. Each copy carries the campaign settings (priority, weight, optimization, labels, autolink categories, description), targeting rules, frequency/click/action/no-click and DSP frequency capping, the total limit and action limits, pricing with country and action prices, price adjustment rules, rule groups, piggybacks, PMP deals and competitor campaigns. Request capping and DSP recency capping are not copied. A copy starts switched OFF unless preserveActive=true, which keeps the source campaign's on/off state. Unless dontCopyBanners=true, every non-deleted banner whose creative files are present is copied with its own settings, targeting, capping, limits, pricing and approval status; copied banners keep their source on/off state unless pauseBanners=true switches them off. Placement links are copied only with keepBannersLinked=true (and only to placements the user can access); otherwise copied banners start unlinked. MOVE reassigns the same campaign (IDs unchanged) with all its banners to the target advertiser; its banners lose their placement links unless keepBannersLinked=true. copyCount, dontCopyBanners, pauseBanners and preserveActive apply to COPY only. Both the source campaign and target advertiser must exist and not be deleted.

Path Params

campaignId integer required

Unique identifier of the campaign to copy or move

2001

operation string required

Operation to perform: COPY or MOVE

COPY

advertiserId integer required

ID of the target advertiser to copy/move the campaign to

1001

Form Params

copyCount integer

Number of copies to create, 1 to 20 (COPY only, defaults to 1)

1

keepBannersLinked boolean

Whether the copied or moved banners stay linked to the source banners' placements; when false they end up with no placement links (defaults to false)

false

dontCopyBanners boolean

When true, campaign banners are not copied (COPY only, defaults to false)

false

pauseBanners boolean

When true, the copied banners are switched off; when false they keep the source banners' on/off state (COPY only, defaults to false)

false

preserveActive boolean

When true, the copied campaign keeps the source campaign's on/off state; when false (default) every copy starts switched off (COPY only)

false

name string

Name for the copy (COPY only, at most 500 characters). With copyCount above 1 the later copies are named '<name> 2', '<name> 3'... Omit to keep the source's name (with '_copy' appended when the target advertiser already has one of that name).

Summer Sale - retargeting

Responses

200

Operation completed successfully

400

Wrong request format or entity not found

401

Authentication error

403

Not enough permissions

404

Not found — resource does not exist

500

Internal server error during operation

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/campaign/2001/COPY/1001.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'name=Summer Sale - retargeting' \
  --data-urlencode 'copyCount=1' \
  --data-urlencode 'keepBannersLinked=false'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/campaign/2001/COPY/1001.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"name": "Summer Sale - retargeting", "copyCount": "1", "keepBannersLinked": "false"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/campaign/2001/COPY/1001.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"name":"Summer Sale - retargeting","copyCount":"1","keepBannersLinked":"false"}),
});

console.log(await response.json());

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/campaign/2001/COPY/1001.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("name=Summer%20Sale%20-%20retargeting&copyCount=1&keepBannersLinked=false"))
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

C# Request

using var client = new HttpClient();

var request = new HttpRequestMessage(new HttpMethod("POST"), "https://YOUR-NETWORK-DOMAIN/rest-api/campaign/2001/COPY/1001.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["name"] = "Summer Sale - retargeting", ["copyCount"] = "1", ["keepBannersLinked"] = "false" });

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	req, _ := http.NewRequest("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/campaign/2001/COPY/1001.do", strings.NewReader(`name=Summer%20Sale%20-%20retargeting&copyCount=1&keepBannersLinked=false`))
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

PHP Request

<?php
$ch = curl_init("https://YOUR-NETWORK-DOMAIN/rest-api/campaign/2001/COPY/1001.do");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY", "Content-Type: application/x-www-form-urlencoded"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'name=Summer%20Sale%20-%20retargeting&copyCount=1&keepBannersLinked=false');

echo curl_exec($ch);
curl_close($ch);

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/campaign/2001/COPY/1001.do")
request = Net::HTTP::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/x-www-form-urlencoded'
request.set_form_data('name' => "Summer Sale - retargeting", 'copyCount' => "1", 'keepBannersLinked' => "false")

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body