Add per-action limit

Creates a new per-action conversion limit for the specified entity type, entity ID, and action (goal).

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/per-action/add/limit/{type}/{entityId}.do

Creates a new per-action conversion limit for the specified entity type, entity ID, and action (goal). This allows setting independent daily and total conversion caps for each tracked action, giving finer control than the global limits endpoints. Both dailyConversionsLimit and totalConversionsLimit are optional; omitted values will not be capped. The entity type must be one of BANNER, CAMPAIGN, ADVERTISER, PLACEMENT, or SITE; unsupported types return 400.

Path Params

type string required

Type of the parent entity to add the per-action limit to. Must be one of: BANNER, CAMPAIGN, ADVERTISER, PLACEMENT, SITE

CAMPAIGN

entityId integer required

Unique numeric identifier of the parent entity (banner, campaign, advertiser, placement, or site)

2001

Form Params

actionId integer required

Unique numeric identifier of the action (goal/conversion type) to which this limit applies

10

dailyConversionsLimit integer

Maximum number of conversions allowed per day for this action; 0 is no daily cap. Omitted, a new limit has none and an action that already has a limit keeps its daily cap

1000

totalConversionsLimit integer

Maximum total number of conversions allowed for this action across the entire limit period; 0 is no total cap. Omitted, a new limit has none and an action that already has a limit keeps its total cap

50000

Responses

200

Per-action limit added successfully

400

Invalid parameters or unsupported entity type

401

Authentication error

403

The role lacks the permission the message names, or the entity is not yours to change

404

Not found — resource does not exist

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/per-action/add/limit/CAMPAIGN/2001.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'actionId=10' \
  --data-urlencode 'dailyConversionsLimit=1000' \
  --data-urlencode 'totalConversionsLimit=50000'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/per-action/add/limit/CAMPAIGN/2001.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"actionId": "10", "dailyConversionsLimit": "1000", "totalConversionsLimit": "50000"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/per-action/add/limit/CAMPAIGN/2001.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"actionId":"10","dailyConversionsLimit":"1000","totalConversionsLimit":"50000"}),
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/per-action/add/limit/CAMPAIGN/2001.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("actionId=10&dailyConversionsLimit=1000&totalConversionsLimit=50000"))
    .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/per-action/add/limit/CAMPAIGN/2001.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["actionId"] = "10", ["dailyConversionsLimit"] = "1000", ["totalConversionsLimit"] = "50000" });

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/per-action/add/limit/CAMPAIGN/2001.do", strings.NewReader(`actionId=10&dailyConversionsLimit=1000&totalConversionsLimit=50000`))
	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/per-action/add/limit/CAMPAIGN/2001.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, 'actionId=10&dailyConversionsLimit=1000&totalConversionsLimit=50000');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/per-action/add/limit/CAMPAIGN/2001.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('actionId' => "10", 'dailyConversionsLimit' => "1000", 'totalConversionsLimit' => "50000")

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