Update banner custom parameters

Replaces the custom key-value parameters for the specified banner.

Reference

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

Replaces the custom key-value parameters for the specified banner. The request body is a JSON array of objects with optional 'id' (for existing parameters), 'name', and 'value' fields. Omitting 'id' creates a new parameter; the banner's parameters the array leaves out are deleted. An id that is not one of this banner's parameters, or an entry without name or value, is refused with 400 and nothing changes; so is a banner that is not native (EXTERNAL_NATIVE or LOCAL_NATIVE), where the parameters would do nothing. Requires UPDATE permission on the banner's advertiser.

Path Params

bannerId integer required

ID of the banner to update custom parameters for

3001

Body

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

[
  {
    "id": "0",
    "name": "headline",
    "value": "Buy Now — 50% Off!"
  }
]

Responses

200

Custom parameters updated successfully

400

Wrong request format, an invalid entry, or an id that is not one of the banner's parameters

401

Authentication error

403

Not enough permissions

404

Not found — resource does not exist

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/custom/parameters.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "id": "0",
    "name": "headline",
    "value": "Buy Now — 50% Off!"
  }
]'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/custom/parameters.do", headers={"X-Api-Key": "YOUR_API_KEY"}, json=[
    {
        "id": "0",
        "name": "headline",
        "value": "Buy Now — 50% Off!"
    }
])
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/custom/parameters.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' },
  body: JSON.stringify([
    {
      "id": "0",
      "name": "headline",
      "value": "Buy Now — 50% Off!"
    }
  ]),
});

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/custom/parameters.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("[{\"id\":\"0\",\"name\":\"headline\",\"value\":\"Buy Now — 50% Off!\"}]"))
    .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/custom/parameters.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new StringContent("[{\"id\":\"0\",\"name\":\"headline\",\"value\":\"Buy Now — 50% Off!\"}]", 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/custom/parameters.do", strings.NewReader(`[{"id":"0","name":"headline","value":"Buy Now — 50% Off!"}]`))
	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/custom/parameters.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, '[{"id":"0","name":"headline","value":"Buy Now — 50% Off!"}]');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/custom/parameters.do")
request = Net::HTTP::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/json'
request.body = "[{\"id\":\"0\",\"name\":\"headline\",\"value\":\"Buy Now — 50% Off!\"}]"

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