Set banner country pricing

Creates or updates a country-specific price override for the specified banner.

Reference

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

Creates or updates a country-specific price override for the specified banner. The banner must already have a base pricing record configured. The country code must be a valid ISO 3166 two-letter code; it is case-insensitive (us and US are the same row), and Great Britain is stored and read back as UK, GB being accepted for it. price is required and must be between 0 and 1000000; a missing or out-of-range price is answered with a 400 naming it and nothing is written. On a CPA banner, actionId prices one conversion action in that country (an action the caller can see in the console's action list); without it the price is for every action. On any other pricing type actionId does not apply and is listed in ignoredFields. Requires UPDATE permission and MANAGE_PRICING permission.

Path Params

bannerId integer required

ID of the banner to set country pricing for

3001

countryCode string required

ISO 3166 two-letter country code (e.g., US, GB)

US

Form Params

price number required

Price for the country, 0 to 1000000

1.75

actionId integer

CPA banners only: the conversion action this country price is for; omit to price every action

42

Responses

200

Country pricing updated

400

Missing or out-of-range price, unknown country, or no base pricing yet

401

Authentication error

403

Not enough permissions

404

Banner not found, or actionId names no action the caller can see

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/pricing/US.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'price=1.75' \
  --data-urlencode 'actionId=42'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/pricing/US.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"price": "1.75", "actionId": "42"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/pricing/US.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"price":"1.75","actionId":"42"}),
});

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/pricing/US.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("price=1.75&actionId=42"))
    .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/pricing/US.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["price"] = "1.75", ["actionId"] = "42" });

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/pricing/US.do", strings.NewReader(`price=1.75&actionId=42`))
	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/banner/3001/pricing/US.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, 'price=1.75&actionId=42');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/pricing/US.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('price' => "1.75", 'actionId' => "42")

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