/

Browse the help center

Set campaign limits

Creates or replaces limits for the specified campaign.

Reference

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

Creates or replaces limits for the specified campaign. If the campaign does not have limits enabled yet, this endpoint will automatically enable them before applying the provided values. Accepts form parameters for total/daily thresholds (impressions, clicks, conversions, budget), date range, evenPacing, useLocalTime flag, and timezoneOffset (in minutes). Requires UPDATE permission on the campaign's parent advertiser and the MANAGE_CAPPING_AND_LIMITATIONS user permission. Each cap changed also needs its own limit permission enabled (e.g. WEEKLY_CLICKS_LIMIT, MONTHLY_BUDGET — the permission of the console Limits card row); a cap the role lacks it for is not applied and is listed in ignoredFields naming the permission, while the other fields are saved. A cap sent with its stored value needs no permission. Counters (the same names without the Limit suffix, e.g. totalImpressions) are read-only here: sent, they are listed in ignoredFields and left unchanged; the reset endpoint sets them back to zero.

Path Params

campaignId integer required

Unique numeric identifier of the campaign whose limits should be created or replaced

2001

Form Params

dailyBudgetLimit number

Maximum daily budget (revenue) in currency units

500.00

dailyClicksLimit integer

Maximum clicks allowed per day

2000

dailyConversionsLimit integer

Maximum conversions allowed per day

500

dailyImpressionsLimit integer

Maximum impressions allowed per day

50000

dailyOpportunitiesLimit integer

Maximum ad opportunities allowed per day

100000

endDate string

End date for the limiting period in yyyy-MM-dd-HH-mm (or yyyy-MM-dd HH:mm) format (GMT+0)

2025-12-31-23-59

evenPacing boolean

When true, distributes delivery evenly throughout the day rather than front-loading

true

monthlyBudgetLimit number

Monthly budget cap; 0 means no monthly cap. Resets on the 1st of the month.

3000

monthlyClicksLimit integer

Maximum clicks allowed per month; 0 means no monthly cap. Resets the 1st of the month.

10000

monthlyConversionsLimit integer

Maximum conversions allowed per month; 0 means no monthly cap. Resets the 1st of the month.

10000

monthlyImpressionsLimit integer

Maximum impressions allowed per calendar month; 0 means no monthly cap. Resets on the 1st.

1500000

monthlyOpportunitiesLimit integer

Maximum opportunities allowed per month; 0 means no monthly cap. Resets the 1st of the month.

10000

removeEndDateLimit boolean

When true, removes the existing end date limit

true

removeStartDateLimit boolean

When true, removes the existing start date limit

true

startDate string

Start date for the limiting period in yyyy-MM-dd-HH-mm (or yyyy-MM-dd HH:mm) format (GMT+0)

2025-01-15-00-00

timezoneOffset integer

The caller's offset from UTC in minutes (east positive, e.g. 120 for UTC+2). With useLocalTime on, the startDate/endDate of this request are read in that offset and stored in UTC; dates not sent are left as stored

120

totalBudgetLimit number

Maximum total budget (revenue) allowed over the entire period in currency units

10000.00

totalClicksLimit integer

Maximum total clicks allowed over the entire period

50000

totalConversionsLimit integer

Maximum total conversions allowed over the entire period

5000

totalImpressionsLimit integer

Maximum total impressions allowed over the entire period

1000000

totalOpportunitiesLimit integer

Maximum total ad opportunities over the entire period

5000000

useLocalTime boolean

When true, startDate/endDate are given in the caller's local time (the console's Local Time switch); the limit read answers them in local time too when it is passed the same timezoneOffset, and in UTC otherwise. Omitted, the limit keeps its current setting

true

weeklyBudgetLimit number

Weekly budget cap; 0 means no weekly cap. Resets each ISO week (Monday).

700

weeklyClicksLimit integer

Maximum clicks allowed per week; 0 means no weekly cap. Resets each ISO week (Monday).

10000

weeklyConversionsLimit integer

Maximum conversions allowed per week; 0 means no weekly cap. Resets each ISO week (Monday).

10000

weeklyImpressionsLimit integer

Maximum impressions allowed per week; 0 means no weekly cap. Resets each ISO week (Monday).

10000

weeklyOpportunitiesLimit integer

Maximum opportunities allowed per week; 0 means no weekly cap. Resets each ISO week (Monday).

10000

Responses

200

Campaign limits set successfully

400

Invalid request parameters or campaign not found

401

Authentication error

403

Not enough permissions

404

Not found — resource does not exist

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/campaign/2001/limits/set.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'dailyBudgetLimit=500.00' \
  --data-urlencode 'dailyClicksLimit=2000' \
  --data-urlencode 'dailyConversionsLimit=500'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/campaign/2001/limits/set.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"dailyBudgetLimit": "500.00", "dailyClicksLimit": "2000", "dailyConversionsLimit": "500"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/campaign/2001/limits/set.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"dailyBudgetLimit":"500.00","dailyClicksLimit":"2000","dailyConversionsLimit":"500"}),
});

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/limits/set.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("dailyBudgetLimit=500.00&dailyClicksLimit=2000&dailyConversionsLimit=500"))
    .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/limits/set.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["dailyBudgetLimit"] = "500.00", ["dailyClicksLimit"] = "2000", ["dailyConversionsLimit"] = "500" });

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/limits/set.do", strings.NewReader(`dailyBudgetLimit=500.00&dailyClicksLimit=2000&dailyConversionsLimit=500`))
	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/limits/set.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, 'dailyBudgetLimit=500.00&dailyClicksLimit=2000&dailyConversionsLimit=500');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/campaign/2001/limits/set.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('dailyBudgetLimit' => "500.00", 'dailyClicksLimit' => "2000", 'dailyConversionsLimit' => "500")

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