/

Browse the help center

Copy or move banner to campaign

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

Reference

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

Copies or moves an existing banner to a campaign (the same or another one). COPY creates copyCount new banners (1 to 20, default 1; anything else is a 400 naming the limit) and returns their IDs in 'created' and, in 'copies', each copy's id, name and whether it starts active (a copy keeps the source banner's on/off state). 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 campaign already has a banner of the source's name, and the source's own name otherwise. A copy carries the creative and its files, the banner settings, labels, size, approval status, targeting rules, frequency/click/action/no-click capping, the total limit and action limits, pricing with country prices, price adjustment rules, rule groups, template values, tracking code, native and VAST settings; request capping is not copied. A copy keeps the source banner's on/off state, so a switched-on source yields an active copy. Placement links are copied only with keepBannersLinked=true. MOVE reassigns the same banner (ID unchanged) to the target campaign and returns moved=true; it loses its placement links unless keepBannersLinked=true. The source banner must have its creative files present.

Path Params

bannerId integer required

ID of the banner to copy or move

3001

operation string required

Operation to perform: COPY or MOVE

COPY

campaignId integer required

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

2001

Form Params

copyCount integer

Number of copies to create, 1 to 20 (only for COPY operation, default: 1)

1

keepBannersLinked boolean

If true, the copied or moved banner stays linked to the source banner's placements (those the user can access); if false it ends up with no placement links

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 campaign already has one of that name).

Summer Sale 300x250 - B

Responses

200

Banner copied or moved successfully

400

Invalid banner, campaign, or operation

401

Authentication error

403

Not enough permissions

404

Not found — resource does not exist

500

Internal server error. When a COPY fails after saving some copies, the message says which copy failed and created lists the saved copies

Language

cURL Request

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

Python Request

import requests

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

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/COPY/2001.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"name":"Summer Sale 300x250 - B","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/banner/3001/COPY/2001.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("name=Summer%20Sale%20300x250%20-%20B&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/banner/3001/COPY/2001.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["name"] = "Summer Sale 300x250 - B", ["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/banner/3001/COPY/2001.do", strings.NewReader(`name=Summer%20Sale%20300x250%20-%20B&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/banner/3001/COPY/2001.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%20300x250%20-%20B&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/banner/3001/COPY/2001.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 300x250 - B", 'copyCount' => "1", 'keepBannersLinked' => "false")

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