Update banner CPA action pricing

Creates or updates the CPA action pricing for the specified banner.

Reference

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

Creates or updates the CPA action pricing for the specified banner. Identifies the action by either actionKey or actionName (key takes precedence). If no CPA pricing record exists, one is created automatically. 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. Only an action the caller can see in the console's action list can be priced; any other is answered as an unknown one. Requires UPDATE permission on the banner's advertiser and MANAGE_PRICING permission, and CPA_PRICING_TYPE when the banner has no pricing yet.

Path Params

bannerId integer required

ID of the banner

3001

Form Params

price number required

Action price value, 0 to 1000000

1.5

actionName string

Name of the action to price

registration

actionKey string

Key of the action to price (takes precedence over actionName)

reg_complete

Responses

200

Action pricing updated

400

Invalid request, banner not found, or pricing type is not CPA

401

Authentication error

403

Not enough permissions

404

No action the caller can see matches actionKey/actionName

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/bannerPricing/actionPricing.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'price=1.5' \
  --data-urlencode 'actionName=registration' \
  --data-urlencode 'actionKey=reg_complete'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/bannerPricing/actionPricing.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"price": "1.5", "actionName": "registration", "actionKey": "reg_complete"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/bannerPricing/actionPricing.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"price":"1.5","actionName":"registration","actionKey":"reg_complete"}),
});

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/bannerPricing/actionPricing.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("price=1.5&actionName=registration&actionKey=reg_complete"))
    .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/bannerPricing/actionPricing.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["price"] = "1.5", ["actionName"] = "registration", ["actionKey"] = "reg_complete" });

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/bannerPricing/actionPricing.do", strings.NewReader(`price=1.5&actionName=registration&actionKey=reg_complete`))
	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/bannerPricing/actionPricing.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.5&actionName=registration&actionKey=reg_complete');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/bannerPricing/actionPricing.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.5", 'actionName' => "registration", 'actionKey' => "reg_complete")

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