Copy placement

Copies a placement to a target zone, optionally keeping banner links.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/placements/copy-placement.do

Copies a placement to a target zone, optionally keeping banner links. Returns the new placement ids in 'newItemIds' and, in 'copies', each copy's id, name and whether it starts active (a copy keeps the source placement'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 zone already has a placement of the source's name, and the source's own name otherwise.

Form Params

placementId integer required

Source placement ID to copy from (must exist and not be deleted)

4001

zoneId integer required

Target zone ID to copy the placement into (must exist and not be deleted)

3001

keepBannersLinked boolean

Whether to keep banners linked to the new placement copy

true

count integer

Number of placement copies to create, 1 to 20

1

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

Homepage Leaderboard - mobile

Responses

200

Placement copied successfully

400

Placement or zone deleted, or count outside 1 to 20

401

Authentication error

403

Forbidden — insufficient permissions

404

No placement or zone with the id sent

Language

cURL Request

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

Python Request

import requests

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

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/placements/copy-placement.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"placementId":"4001","zoneId":"3001","name":"Homepage Leaderboard - 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/placements/copy-placement.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("placementId=4001&zoneId=3001&name=Homepage%20Leaderboard%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/placements/copy-placement.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["placementId"] = "4001", ["zoneId"] = "3001", ["name"] = "Homepage Leaderboard - 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/placements/copy-placement.do", strings.NewReader(`placementId=4001&zoneId=3001&name=Homepage%20Leaderboard%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/placements/copy-placement.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, 'placementId=4001&zoneId=3001&name=Homepage%20Leaderboard%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/placements/copy-placement.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('placementId' => "4001", 'zoneId' => "3001", 'name' => "Homepage Leaderboard - mobile", 'keepBannersLinked' => "true", 'count' => "1")

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