Update banner pricing

Creates or updates the pricing configuration for the specified banner.

Reference

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

Creates or updates the pricing configuration for the specified banner. Accepts price (double, 0 to 1000000), pricingType (CPM, CPC, or CPA), paymentModel (REVENUE_SHARE or FIXED_PRICE) and useGlobalActionPricing as form parameters. Only the fields sent are changed; the rest keep their stored values (an empty price clears the banner's own price). If no pricing record exists for this banner, a new one is created with FIXED_PRICE, CPM and no price for whatever is not sent. Requires UPDATE permission on the banner's advertiser and MANAGE_PRICING permission, and setting a pricing type (including the CPM of a new record) requires that type's permission, e.g. CPM_PRICING_TYPE.

Path Params

bannerId integer required

ID of the banner to update pricing for

3001

Form Params

paymentModel string

Payment model (FIXED_PRICE, REVENUE_SHARE)

FIXED_PRICE

price number

Price value in the selected pricing type; null when no global price is set

2.50

pricingType string

Pricing type (CPM, CPC, CPA, COST_PER_DAY, COST_PER_MONTH)

CPM

useGlobalActionPricing boolean

Whether to use global action pricing from the action definition

true

Responses

200

Banner pricing updated

400

Invalid request, e.g. a price out of range, naming the field

401

Authentication error

403

Not enough permissions

404

Banner not found

Language

cURL Request

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

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/pricing.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"paymentModel": "FIXED_PRICE", "price": "2.50", "pricingType": "CPM"})
print(response.json())

Node Request

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

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

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.do", strings.NewReader(`paymentModel=FIXED_PRICE&price=2.50&pricingType=CPM`))
	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.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, 'paymentModel=FIXED_PRICE&price=2.50&pricingType=CPM');

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.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('paymentModel' => "FIXED_PRICE", 'price' => "2.50", 'pricingType' => "CPM")

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