Set placement use general action pricing

Turns the CPA "Use general action pricing" setting of the placement's fixed pricing on or off, as the checkbox on the console's Pricing card does.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/placements/{placementId}/pricing/use-global-action-pricing.do

Turns the CPA "Use general action pricing" setting of the placement's fixed pricing on or off, as the checkbox on the console's Pricing card does. With it on, a conversion the placement has no per-action price for is paid at the conversion action's own (general) price - its price for the country first, then its price for every country - before the placement's global price; with it off, only the placement's own prices apply. The placement's per-action prices win either way. The placement must have fixed pricing of type CPA. The matching GET /rest-api/placements/{placementId}/pricing.do returns it as useGlobalActionPricing. Requires ENABLED level on the SITE_PAYMENT_MODEL permission and update access to the placement's site.

Path Params

placementId integer required

Unique numeric ID of the placement

4001

Form Params

useGlobalActionPricing boolean required

true to fall back to the network's general action pricing, false to use only the placement's own prices

false

Responses

200

Setting saved; the answer repeats the stored value

400

The placement has no fixed pricing, or its pricing type is not CPA

401

Authentication error

403

Missing SITE_PAYMENT_MODEL permission or no update access to the site

404

Placement not found or deleted

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/placements/4001/pricing/use-global-action-pricing.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'useGlobalActionPricing=false'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/placements/4001/pricing/use-global-action-pricing.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"useGlobalActionPricing": "false"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/placements/4001/pricing/use-global-action-pricing.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"useGlobalActionPricing":"false"}),
});

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

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/pricing/use-global-action-pricing.do", strings.NewReader(`useGlobalActionPricing=false`))
	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/pricing/use-global-action-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, 'useGlobalActionPricing=false');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/placements/4001/pricing/use-global-action-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('useGlobalActionPricing' => "false")

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