Filter a delivery priority of placement daisy chaining by country

Sets one delivery priority's filter on a chain grouped by delivery priority, as the priority rows under the console's 'Apply delivery priorities' option do.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/placements/{placementId}/chaining/delivery-priority-filter.do

Sets one delivery priority's filter on a chain grouped by delivery priority, as the priority rows under the console's 'Apply delivery priorities' option do. enabled=true keeps the priority's campaigns or banners in the chain for the countries sent (ISO alpha-2 codes, repeat the parameter; '*' or none sent means every country), replacing the priority's previous countries; enabled=false leaves the priority out of the chain. Grouping switches every priority on for every country. Needs the Daisy Chaining permission and update rights on the placement's site.

Path Params

placementId integer required

Placement id

4001

Form Params

deliveryPriority string required

The delivery priority the filter is for

STANDARD_HIGH

enabled boolean required

true keeps the priority in the chain for the countries sent, false leaves it out

true

countries array<string>

ISO alpha-2 country codes, or '*' for every country; none sent means every country

US

Responses

200

The chain's settings, as the setup endpoint answers, with deliveryPriorityFilters

400

Daisy chaining is off or not grouped by delivery priority, or an unknown country code

401

Authentication error

403

The Daisy Chaining permission is off, or no update rights on the placement's site

404

The placement does not exist or is deleted

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/placements/4001/chaining/delivery-priority-filter.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'deliveryPriority=STANDARD_HIGH' \
  --data-urlencode 'enabled=true' \
  --data-urlencode 'countries=US'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/placements/4001/chaining/delivery-priority-filter.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"deliveryPriority": "STANDARD_HIGH", "enabled": "true", "countries": "US"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/placements/4001/chaining/delivery-priority-filter.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"deliveryPriority":"STANDARD_HIGH","enabled":"true","countries":"US"}),
});

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/chaining/delivery-priority-filter.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("deliveryPriority=STANDARD_HIGH&enabled=true&countries=US"))
    .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/chaining/delivery-priority-filter.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["deliveryPriority"] = "STANDARD_HIGH", ["enabled"] = "true", ["countries"] = "US" });

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/chaining/delivery-priority-filter.do", strings.NewReader(`deliveryPriority=STANDARD_HIGH&enabled=true&countries=US`))
	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/chaining/delivery-priority-filter.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, 'deliveryPriority=STANDARD_HIGH&enabled=true&countries=US');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/placements/4001/chaining/delivery-priority-filter.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('deliveryPriority' => "STANDARD_HIGH", 'enabled' => "true", 'countries' => "US")

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