Update a placement's content replacement rule

Changes one rule as editing a row of the placement's Content replacement card does.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/placements/{placementId}/content-replacement/{ruleId}/update.do

Changes one rule as editing a row of the placement's Content replacement card does. A field not sent keeps its value; an empty 'replacement' makes the rule delete its target from the markup. A new 'target' follows the create rules: not blank, up to 255 characters, not a target another rule of the placement already has. Requires the PLACEMENT_CONTENT_REPLACEMENT permission and update rights on the placement's site. Parameters that were sent but not applied are listed in 'ignoredFields', each with its reason in 'ignoredFieldReasons'.

Path Params

placementId integer required

Placement id

4001

ruleId integer required

Rule id, as the list returns it

51

Form Params

replacement string

What every occurrence of the target becomes; may contain macros such as $$RANDOM$$. Empty or omitted on create removes the target from the markup.

https://cdn.northwind.example/

target string

The exact text to find in every ad markup the placement serves — literal, no wildcards or regex; up to 255 characters, unique within the placement. Required on create.

http://cdn.northwind.example/

Responses

200

Rule updated: {success, placementId, rule:{id, target, replacement}}

400

Field errors under 'errors': target blank, too long or already used; replacement too long

401

Authentication error

403

The role lacks PLACEMENT_CONTENT_REPLACEMENT, or no update rights on the placement's site

404

The placement does not exist or is deleted, or it has no rule with this id

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/placements/4001/content-replacement/51/update.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'replacement=https://cdn.northwind.example/' \
  --data-urlencode 'target=http://cdn.northwind.example/'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/placements/4001/content-replacement/51/update.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"replacement": "https://cdn.northwind.example/", "target": "http://cdn.northwind.example/"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/placements/4001/content-replacement/51/update.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"replacement":"https://cdn.northwind.example/","target":"http://cdn.northwind.example/"}),
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/placements/4001/content-replacement/51/update.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("replacement=https%3A%2F%2Fcdn.northwind.example%2F&target=http%3A%2F%2Fcdn.northwind.example%2F"))
    .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/placements/4001/content-replacement/51/update.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["replacement"] = "https://cdn.northwind.example/", ["target"] = "http://cdn.northwind.example/" });

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/placements/4001/content-replacement/51/update.do", strings.NewReader(`replacement=https%3A%2F%2Fcdn.northwind.example%2F&target=http%3A%2F%2Fcdn.northwind.example%2F`))
	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/placements/4001/content-replacement/51/update.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, 'replacement=https%3A%2F%2Fcdn.northwind.example%2F&target=http%3A%2F%2Fcdn.northwind.example%2F');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/placements/4001/content-replacement/51/update.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('replacement' => "https://cdn.northwind.example/", 'target' => "http://cdn.northwind.example/")

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