/

Browse the help center

Update campaign pricing

Updates pricing settings for the specified campaign, or creates a new pricing record with system defaults if one does not yet exist.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/campaign/{campaignId}/pricing.do

Updates pricing settings for the specified campaign, or creates a new pricing record with system defaults if one does not yet exist. Accepts price, paymentModel (FIXED_PRICE or REVENUE_SHARE), pricingType (CPM, CPC, CPA), and optimization parameters such as estimatedCtr, estimatedConversionRate, burnUpPeriod, startUpPeriod, minClicks, minConversions and useGlobalActionPricing. Only the fields sent are changed; the rest keep their stored values. Switching pricingType, or creating the pricing record (CPM when pricingType is not sent), needs that pricing type's permission and, on a switch, as in the console, deletes the campaign's country and action prices and its global price (send price in the same call to set the new one). estimatedCtr and estimatedConversionRate are fractions between 0 and 1 (0.05 means 5%); price must be between 0 and 1000000; burnUpPeriod must be >= startUpPeriod. A value out of range is answered with 400 naming the field.

Path Params

campaignId integer required

Unique identifier of the campaign whose pricing to update

2001

Form Params

burnUpPeriod integer

Burn-up period in hours for eCPM optimization

24

burnUpSubPeriod integer

Burn-up sub-period length in hours

6

burnUpSubPeriodWeighting string

Weighting type for burn-up sub-periods

SINGLET

estimatedConversionRate number

Estimated impression-to-conversion rate (I2C) as a fraction from 0 to 1, not a percentage — 0.002 means 0.2%. Used to estimate eCPM of CPA campaigns under eCPM optimization; omit to keep the current value (a new pricing record starts from the network default)

0.002

estimatedCtr number

Estimated click-through rate as a fraction from 0 to 1, not a percentage — 0.005 means 0.5% CTR. Used to estimate eCPM of CPC campaigns under eCPM optimization; omit to keep the current value (a new pricing record starts from the network default)

0.005

minClicks integer

Minimum number of clicks before optimization kicks in

50

minConversions integer

Minimum number of conversions before optimization kicks in

10

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

startUpPeriod integer

Start-up period in hours for eCPM optimization; must not exceed burnUpPeriod

12

useGlobalActionPricing boolean

Whether to use global action pricing from the action definition

true

Responses

200

Campaign pricing updated

400

Wrong request format or invalid parameters

401

Authentication error

403

Not enough permissions, including the permission of a pricingType being switched to

404

Not found — resource does not exist

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/campaign/2001/pricing.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'burnUpPeriod=24' \
  --data-urlencode 'burnUpSubPeriod=6' \
  --data-urlencode 'burnUpSubPeriodWeighting=SINGLET'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/campaign/2001/pricing.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"burnUpPeriod": "24", "burnUpSubPeriod": "6", "burnUpSubPeriodWeighting": "SINGLET"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/campaign/2001/pricing.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"burnUpPeriod":"24","burnUpSubPeriod":"6","burnUpSubPeriodWeighting":"SINGLET"}),
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/campaign/2001/pricing.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("burnUpPeriod=24&burnUpSubPeriod=6&burnUpSubPeriodWeighting=SINGLET"))
    .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/campaign/2001/pricing.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["burnUpPeriod"] = "24", ["burnUpSubPeriod"] = "6", ["burnUpSubPeriodWeighting"] = "SINGLET" });

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/campaign/2001/pricing.do", strings.NewReader(`burnUpPeriod=24&burnUpSubPeriod=6&burnUpSubPeriodWeighting=SINGLET`))
	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/campaign/2001/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, 'burnUpPeriod=24&burnUpSubPeriod=6&burnUpSubPeriodWeighting=SINGLET');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/campaign/2001/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('burnUpPeriod' => "24", 'burnUpSubPeriod' => "6", 'burnUpSubPeriodWeighting' => "SINGLET")

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