Update banner landing URLs in batch

Updates landing URLs for multiple banners in a single request.

Reference

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

Updates landing URLs for multiple banners in a single request. The request body must contain a JSON array of {id, url} objects mapping banner IDs to their new landing URLs. Each URL is validated before saving (a scheme and a host are required). The response lists the banners saved in 'updated' and every refused one in 'failures' as {id, error} (error: 'invalid_url', 'no_url_property_found', 'permission_denied', 'not_found', 'deleted', 'banner_file_missing', 'not_saved'), with an overall success flag. The older per-banner keys are still sent. An entry without an id is refused with 400 and nothing changes.

Body

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

[
  {
    "url": "https://advertiser.example.com/landing-page",
    "id": "5001"
  }
]

Responses

200

Every banner was saved, or some were: success=false with 'failures' when not all of them

400

Wrong request format, an entry without an id, or no banner was saved (see 'failures')

401

Authentication error

403

No banner was saved because the caller may not update them

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/banners/urls.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "url": "https://advertiser.example.com/landing-page",
    "id": "5001"
  }
]'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/banners/urls.do", headers={"X-Api-Key": "YOUR_API_KEY"}, json=[
    {
        "url": "https://advertiser.example.com/landing-page",
        "id": "5001"
    }
])
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/banners/urls.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' },
  body: JSON.stringify([
    {
      "url": "https://advertiser.example.com/landing-page",
      "id": "5001"
    }
  ]),
});

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/urls.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("[{\"url\":\"https://advertiser.example.com/landing-page\",\"id\":\"5001\"}]"))
    .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/urls.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new StringContent("[{\"url\":\"https://advertiser.example.com/landing-page\",\"id\":\"5001\"}]", 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/banners/urls.do", strings.NewReader(`[{"url":"https://advertiser.example.com/landing-page","id":"5001"}]`))
	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/banners/urls.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, '[{"url":"https://advertiser.example.com/landing-page","id":"5001"}]');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/banners/urls.do")
request = Net::HTTP::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/json'
request.body = "[{\"url\":\"https://advertiser.example.com/landing-page\",\"id\":\"5001\"}]"

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