Update banner placements

Creates or updates the set of placements linked to a banner.

Reference

PUT https://YOUR-NETWORK-DOMAIN/rest-api/banners/{bannerId}/placements.do

Creates or updates the set of placements linked to a banner. When 'append' is false (default), the provided placement IDs completely replace all existing links, and every link that would be removed must be on a site the caller may manage links on (otherwise placements_cannot_be_linked lists them and nothing changes); when true, they are added to the current set. The caller must have the LINK_PLACEMENTS_TO_BANNERS permission (shared or all level). Returns a JSON object with 'success' status; on permission failure returns {"success":false, "error":"permission_denied"}. An id of no placement or of a deleted one is skipped and listed in 'skipped' with the reason; every other placement must be compatible with the banner type.

Path Params

bannerId integer required

Unique identifier of the banner to update placement links for

42

Form Params

ids array<integer> required

Array of placement IDs to link to the banner. An id of no placement or of a deleted one is skipped and listed in 'skipped' with the reason; every other placement must be compatible with the banner type

3001

append boolean

When true, the provided placement IDs are added to the existing linked placements. When false (default), the provided IDs replace all existing links

false

Responses

200

Operation result with success status

400

Bad request — invalid or missing parameters

401

Authentication error

403

Forbidden — insufficient permissions

404

Not found — resource does not exist

Language

cURL Request

curl --request PUT \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/banners/42/placements.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'ids=3001' \
  --data-urlencode 'append=true'

Python Request

import requests

response = requests.request("PUT", "https://YOUR-NETWORK-DOMAIN/rest-api/banners/42/placements.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"ids": "3001", "append": "true"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/banners/42/placements.do', {
  method: 'PUT',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"ids":"3001","append":"true"}),
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/banners/42/placements.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("PUT", HttpRequest.BodyPublishers.ofString("ids=3001&append=true"))
    .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("PUT"), "https://YOUR-NETWORK-DOMAIN/rest-api/banners/42/placements.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["ids"] = "3001", ["append"] = "true" });

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("PUT", "https://YOUR-NETWORK-DOMAIN/rest-api/banners/42/placements.do", strings.NewReader(`ids=3001&append=true`))
	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/banners/42/placements.do");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY", "Content-Type: application/x-www-form-urlencoded"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'ids=3001&append=true');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/banners/42/placements.do")
request = Net::HTTP::Put.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/x-www-form-urlencoded'
request.set_form_data('ids' => "3001", 'append' => "true")

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