Update campaign action pricing

Sets or updates the CPA price for a specific action within the campaign's pricing.

Reference

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

Sets or updates the CPA price for a specific action within the campaign's pricing. The action can be identified by either its name (actionName) or its unique key (actionKey). If campaign pricing does not yet exist, it is created with CPA pricing type and FIXED_PRICE payment model, which needs the CPA_PRICING_TYPE permission. If pricing already exists, it must be of CPA type; otherwise a 400 error is returned. 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.

Path Params

campaignId integer required

Unique identifier of the campaign

2001

Form Params

price number required

CPA price for the action, 0 to 1000000

2.50

actionName string

Name of the action to set pricing for (alternative to actionKey)

registration

actionKey string

Unique key of the action to set pricing for (alternative to actionName)

reg_complete

Responses

200

Action pricing updated

400

Wrong request format or invalid parameters

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/campaign/2001/campaignPricing/actionPricing.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'price=2.50' \
  --data-urlencode 'actionName=registration' \
  --data-urlencode 'actionKey=reg_complete'

Python Request

import requests

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

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/campaign/2001/campaignPricing/actionPricing.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"price":"2.50","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/campaign/2001/campaignPricing/actionPricing.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("price=2.50&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/campaign/2001/campaignPricing/actionPricing.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["price"] = "2.50", ["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/campaign/2001/campaignPricing/actionPricing.do", strings.NewReader(`price=2.50&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/campaign/2001/campaignPricing/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=2.50&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/campaign/2001/campaignPricing/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' => "2.50", 'actionName' => "registration", 'actionKey' => "reg_complete")

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