Bulk copy campaigns

Copies one or more campaigns to a target advertiser in a single bulk operation.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/campaigns/copy/bulk/{advertiserId}.do

Copies one or more campaigns to a target advertiser in a single bulk operation. Each campaign in the request names its source (companyId), a new name (companyName) and the banners to copy (banners: send [] for none), each with itemId (item_id is accepted too), link and active. The 'numberOfCopies' parameter controls how many copies of each campaign are created, 1 to 20 (default 1); an empty request or a count outside that range is a 400. A campaign whose copy fails is listed in failedCampaignIds and success is false; the other campaigns are still copied. The target advertiser must exist and not be deleted. Each source campaign is validated for existence and non-deleted status, and the caller must have UPDATE permission on both the source campaign's advertiser and the target advertiser. Returns a merged result containing new campaign IDs, titles, and success status.

Path Params

advertiserId integer required

Unique identifier of the target advertiser that will own the copied campaigns. Must reference an existing, non-deleted advertiser

1001

Query Params

numberOfCopies integer

Number of copies to create for each campaign in the bulk request, 1 to 20. Defaults to 1 if not specified

1

Body

A JSON body. An example, built from the field definitions:

[
  {
    "companyName": "Summer Campaign (Copy)",
    "companyId": "3001"
  }
]

Responses

200

Bulk copy operation result with new campaign IDs

400

Invalid request format or deleted advertiser/campaign

401

Authentication error

403

Insufficient permissions

404

Advertiser or campaign not found

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/campaigns/copy/bulk/1001.do?numberOfCopies=1' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "companyId": 3001,
    "companyName": "Summer Campaign (Copy)",
    "banners": []
  }
]'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/campaigns/copy/bulk/1001.do?numberOfCopies=1", headers={"X-Api-Key": "YOUR_API_KEY"}, json=[
    {
        "companyId": 3001,
        "companyName": "Summer Campaign (Copy)",
        "banners": []
    }
])
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/campaigns/copy/bulk/1001.do?numberOfCopies=1', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' },
  body: JSON.stringify([
    {
      "companyId": 3001,
      "companyName": "Summer Campaign (Copy)",
      "banners": []
    }
  ]),
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/campaigns/copy/bulk/1001.do?numberOfCopies=1"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("[{\"companyId\":3001,\"companyName\":\"Summer Campaign (Copy)\",\"banners\":[]}]"))
    .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/campaigns/copy/bulk/1001.do?numberOfCopies=1");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new StringContent("[{\"companyId\":3001,\"companyName\":\"Summer Campaign (Copy)\",\"banners\":[]}]", Encoding.UTF8, "application/json");

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/campaigns/copy/bulk/1001.do?numberOfCopies=1", strings.NewReader(`[{"companyId":3001,"companyName":"Summer Campaign (Copy)","banners":[]}]`))
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/json")

	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/campaigns/copy/bulk/1001.do?numberOfCopies=1");
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/json"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '[{"companyId":3001,"companyName":"Summer Campaign (Copy)","banners":[]}]');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/campaigns/copy/bulk/1001.do?numberOfCopies=1")
request = Net::HTTP::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/json'
request.body = "[{\"companyId\":3001,\"companyName\":\"Summer Campaign (Copy)\",\"banners\":[]}]"

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