Copy zone

Copies a zone with its placements into a site, as the console's copy (clipboard) does: the zone's settings and targeting come along, and every placement is copied into the new zone.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/zones/{zoneId}/copy.do

Copies a zone with its placements into a site, as the console's copy (clipboard) does: the zone's settings and targeting come along, and every placement is copied into the new zone. With keepBannersLinked (default true) each copied placement keeps the banners its original is linked to — those the caller may see — plus the ones its auto-linking rules pick. Answers 'newItemIds' (the new zone ids) and 'copies': per new zone its id, name, whether it starts active (a copy keeps the source zone's on/off state) and its 'placements' (id, name, active). A copy is named after the optional 'name' — the first copy takes it as given, later ones get ' 2', ' 3'... appended — or, without it, '<name>_copy' / '<name>_copy(N)' when the site already has a zone of the source's name. Requires access to the source zone's site and UPDATE on the target site.

Path Params

zoneId integer required

ID of the zone to copy

3001

Form Params

siteId integer required

ID of the site to copy the zone into (may be the zone's own site)

2001

name string

Name for the copy (at most 500 characters). With count above 1 the later copies are named '<name> 2', '<name> 3'... Omit to keep the source's name (with '_copy' appended when the site already has a zone of that name).

Homepage - mobile

keepBannersLinked boolean

Whether the copied placements keep the banners linked to the originals

true

count integer

Number of copies to create, 1 to 20

1

Responses

200

Zone copied

400

count outside 1 to 20 or name too long

401

Authentication error

403

No access to the source zone's site or no UPDATE on the target site

404

Zone or site not found or deleted

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/zones/3001/copy.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'siteId=2001' \
  --data-urlencode 'name=Homepage - mobile' \
  --data-urlencode 'keepBannersLinked=true' \
  --data-urlencode 'count=1'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/zones/3001/copy.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"siteId": "2001", "name": "Homepage - mobile", "keepBannersLinked": "true", "count": "1"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/zones/3001/copy.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"siteId":"2001","name":"Homepage - mobile","keepBannersLinked":"true","count":"1"}),
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/zones/3001/copy.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("siteId=2001&name=Homepage%20-%20mobile&keepBannersLinked=true&count=1"))
    .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/zones/3001/copy.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["siteId"] = "2001", ["name"] = "Homepage - mobile", ["keepBannersLinked"] = "true", ["count"] = "1" });

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/zones/3001/copy.do", strings.NewReader(`siteId=2001&name=Homepage%20-%20mobile&keepBannersLinked=true&count=1`))
	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/zones/3001/copy.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, 'siteId=2001&name=Homepage%20-%20mobile&keepBannersLinked=true&count=1');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/zones/3001/copy.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('siteId' => "2001", 'name' => "Homepage - mobile", 'keepBannersLinked' => "true", 'count' => "1")

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