Set a template banner's property values

Changes some property values of a TEMPLATE banner and keeps the rest.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/banner/{bannerId}/template-properties.do

Changes some property values of a TEMPLATE banner and keeps the rest. The JSON body maps each property to its new value, e.g. {"$$PARENT_SELECTOR$$": "#player", "$$INSERTION_TYPE$$": "after"}; a property is named by its key, with or without the $$ around it, or by its title. A SELECT takes one of its options' values, a BOOLEAN true or false, an INTEGER a whole number within its min and max, a STRING what the banner edit accepts (its length, a valid URL where it is a URL); an empty string clears an optional value. The values are checked as the banner edit checks them, and nothing is saved when one is refused. FILE and HTML5_ZIP properties are not set here: send fileUrl[<key>] or html5ZipUrl[<key>] to /rest-api/banner/{bannerId}/update.do. A change to a property under moderation can send the banner back for approval, as in the console. Answers the properties as the GET does. Requires UPDATE permission on the banner's advertiser and, while the template is inactive, the UPDATE_PROPERTIES_OF_INACTIVE_TEMPLATE permission.

Path Params

bannerId integer required

ID of the TEMPLATE banner

3001

Body

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

{}

Responses

200

Saved; the template and its properties with the banner's new values

400

Not a TEMPLATE banner, no values, an unknown property (the message lists the valid keys), a file property, or a value the property refuses (errors by key)

401

Authentication error

403

Not enough permissions

404

Banner not found or deleted

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/template-properties.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "$$PARENT_SELECTOR$$": "#player",
  "$$INSERTION_TYPE$$": "after"
}'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/template-properties.do", headers={"X-Api-Key": "YOUR_API_KEY"}, json={
    "$$PARENT_SELECTOR$$": "#player",
    "$$INSERTION_TYPE$$": "after"
})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/template-properties.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "$$PARENT_SELECTOR$$": "#player",
    "$$INSERTION_TYPE$$": "after"
  }),
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/template-properties.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"$$PARENT_SELECTOR$$\":\"#player\",\"$$INSERTION_TYPE$$\":\"after\"}"))
    .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/banner/3001/template-properties.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new StringContent("{\"$$PARENT_SELECTOR$$\":\"#player\",\"$$INSERTION_TYPE$$\":\"after\"}", 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/banner/3001/template-properties.do", strings.NewReader(`{"$$PARENT_SELECTOR$$":"#player","$$INSERTION_TYPE$$":"after"}`))
	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/banner/3001/template-properties.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/json"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"$$PARENT_SELECTOR$$":"#player","$$INSERTION_TYPE$$":"after"}');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/template-properties.do")
request = Net::HTTP::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/json'
request.body = "{\"$$PARENT_SELECTOR$$\":\"#player\",\"$$INSERTION_TYPE$$\":\"after\"}"

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