Change labels of many banners

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/banners/labels.do

Applies one label change to up to 500 banners in one call: ADD appends the labels, OVERWRITE replaces the banner's labels with them, REMOVE takes them off and CLEAR removes every label (labels is then ignored). Label names that do not exist yet are created when the caller holds the Create Labels permission, otherwise the call is a 400 naming them. Banners whose labels would not change are skipped as 'unchanged', deleted or unknown ids as 'deleted' / 'not-found'. The response lists changed ids and skipped {id, reason} pairs. The batch is all-or-nothing on permissions: without the Banner Labels permission, or if any banner's advertiser is outside the caller's UPDATE share, nothing changes.

Form Params

ids array<integer> required

Banner IDs to change, 1 to 500

3001

labels array<string>

Label names, comma-separated or repeated

premium

labelUpdateType string

ADD (default), OVERWRITE, REMOVE or CLEAR

ADD

Responses

200

Batch applied

400

No ids or more than 500, no labels for ADD / OVERWRITE / REMOVE, or a new label the caller may not create

401

Authentication error

403

Not enough permissions for the whole batch

404

None of the ids names an existing banner

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/banners/labels.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'ids=3001' \
  --data-urlencode 'labels=premium' \
  --data-urlencode 'labelUpdateType=ADD'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/banners/labels.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"ids": "3001", "labels": "premium", "labelUpdateType": "ADD"})
print(response.json())

Node Request

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

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/labels.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("ids=3001&labels=premium&labelUpdateType=ADD"))
    .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/banners/labels.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["ids"] = "3001", ["labels"] = "premium", ["labelUpdateType"] = "ADD" });

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/banners/labels.do", strings.NewReader(`ids=3001&labels=premium&labelUpdateType=ADD`))
	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/labels.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, 'ids=3001&labels=premium&labelUpdateType=ADD');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/banners/labels.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('ids' => "3001", 'labels' => "premium", 'labelUpdateType' => "ADD")

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