Campaign Settings

Update CPC campaign settings.

curl --request POST \
  --url https://studio-api.onlytraffic.com/api/external/v1/cpc/campaigns/{public_id}/settings \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "Reddit push September",
  "max_bid_cents": 55,
  "budget_daily_cents": 5000,
  "budget_total_cents": 100000,
  "date_start": "2026-09-15",
  "date_end": null,
  "status": "active",
  "freq_cap": 3,
  "freq_cap_days": 3,
  "blocked_placements": [
    "site-1f4c9ab2"
  ],
  "link_name_prefix": "CPC"
}
'

import requests

url = "https://studio-api.onlytraffic.com/api/external/v1/cpc/campaigns/{public_id}/settings"

payload = {
    "name": "Reddit push September",
    "max_bid_cents": 55,
    "budget_daily_cents": 5000,
    "budget_total_cents": 100000,
    "date_start": "2026-09-15",
    "date_end": None,
    "status": "active",
    "freq_cap": 3,
    "freq_cap_days": 3,
    "blocked_placements": ["site-1f4c9ab2"],
    "link_name_prefix": "CPC"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Reddit push September',
    max_bid_cents: 55,
    budget_daily_cents: 5000,
    budget_total_cents: 100000,
    date_start: '2026-09-15',
    date_end: null,
    status: 'active',
    freq_cap: 3,
    freq_cap_days: 3,
    blocked_placements: ['site-1f4c9ab2'],
    link_name_prefix: 'CPC'
  })
};

fetch('https://studio-api.onlytraffic.com/api/external/v1/cpc/campaigns/{public_id}/settings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://studio-api.onlytraffic.com/api/external/v1/cpc/campaigns/{public_id}/settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Reddit push September',
    'max_bid_cents' => 55,
    'budget_daily_cents' => 5000,
    'budget_total_cents' => 100000,
    'date_start' => '2026-09-15',
    'date_end' => null,
    'status' => 'active',
    'freq_cap' => 3,
    'freq_cap_days' => 3,
    'blocked_placements' => [
        'site-1f4c9ab2'
    ],
    'link_name_prefix' => 'CPC'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://studio-api.onlytraffic.com/api/external/v1/cpc/campaigns/{public_id}/settings"

	payload := strings.NewReader("{\n  \"name\": \"Reddit push September\",\n  \"max_bid_cents\": 55,\n  \"budget_daily_cents\": 5000,\n  \"budget_total_cents\": 100000,\n  \"date_start\": \"2026-09-15\",\n  \"date_end\": null,\n  \"status\": \"active\",\n  \"freq_cap\": 3,\n  \"freq_cap_days\": 3,\n  \"blocked_placements\": [\n    \"site-1f4c9ab2\"\n  ],\n  \"link_name_prefix\": \"CPC\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://studio-api.onlytraffic.com/api/external/v1/cpc/campaigns/{public_id}/settings")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Reddit push September\",\n  \"max_bid_cents\": 55,\n  \"budget_daily_cents\": 5000,\n  \"budget_total_cents\": 100000,\n  \"date_start\": \"2026-09-15\",\n  \"date_end\": null,\n  \"status\": \"active\",\n  \"freq_cap\": 3,\n  \"freq_cap_days\": 3,\n  \"blocked_placements\": [\n    \"site-1f4c9ab2\"\n  ],\n  \"link_name_prefix\": \"CPC\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://studio-api.onlytraffic.com/api/external/v1/cpc/campaigns/{public_id}/settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Reddit push September\",\n  \"max_bid_cents\": 55,\n  \"budget_daily_cents\": 5000,\n  \"budget_total_cents\": 100000,\n  \"date_start\": \"2026-09-15\",\n  \"date_end\": null,\n  \"status\": \"active\",\n  \"freq_cap\": 3,\n  \"freq_cap_days\": 3,\n  \"blocked_placements\": [\n    \"site-1f4c9ab2\"\n  ],\n  \"link_name_prefix\": \"CPC\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "campaign_id": "cpcp_a1b2c3d4"
  }
}

{
  "success": false,
  "error": "validation_failed",
  "message": "<string>",
  "details": {},
  "retry_after": 123
}

{
  "success": false,
  "error": "validation_failed",
  "message": "<string>",
  "details": {},
  "retry_after": 123
}

{
  "success": false,
  "error": "validation_failed",
  "message": "<string>",
  "details": {},
  "retry_after": 123
}

{
  "success": false,
  "error": "validation_failed",
  "message": "<string>",
  "details": {},
  "retry_after": 123
}

{
  "success": false,
  "error": "validation_failed",
  "message": "<string>",
  "details": {},
  "retry_after": 123
}

POST

cpc

campaigns

{public_id}

settings

Update CPC campaign settings.

curl --request POST \
  --url https://studio-api.onlytraffic.com/api/external/v1/cpc/campaigns/{public_id}/settings \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "Reddit push September",
  "max_bid_cents": 55,
  "budget_daily_cents": 5000,
  "budget_total_cents": 100000,
  "date_start": "2026-09-15",
  "date_end": null,
  "status": "active",
  "freq_cap": 3,
  "freq_cap_days": 3,
  "blocked_placements": [
    "site-1f4c9ab2"
  ],
  "link_name_prefix": "CPC"
}
'

import requests

url = "https://studio-api.onlytraffic.com/api/external/v1/cpc/campaigns/{public_id}/settings"

payload = {
    "name": "Reddit push September",
    "max_bid_cents": 55,
    "budget_daily_cents": 5000,
    "budget_total_cents": 100000,
    "date_start": "2026-09-15",
    "date_end": None,
    "status": "active",
    "freq_cap": 3,
    "freq_cap_days": 3,
    "blocked_placements": ["site-1f4c9ab2"],
    "link_name_prefix": "CPC"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Reddit push September',
    max_bid_cents: 55,
    budget_daily_cents: 5000,
    budget_total_cents: 100000,
    date_start: '2026-09-15',
    date_end: null,
    status: 'active',
    freq_cap: 3,
    freq_cap_days: 3,
    blocked_placements: ['site-1f4c9ab2'],
    link_name_prefix: 'CPC'
  })
};

fetch('https://studio-api.onlytraffic.com/api/external/v1/cpc/campaigns/{public_id}/settings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://studio-api.onlytraffic.com/api/external/v1/cpc/campaigns/{public_id}/settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Reddit push September',
    'max_bid_cents' => 55,
    'budget_daily_cents' => 5000,
    'budget_total_cents' => 100000,
    'date_start' => '2026-09-15',
    'date_end' => null,
    'status' => 'active',
    'freq_cap' => 3,
    'freq_cap_days' => 3,
    'blocked_placements' => [
        'site-1f4c9ab2'
    ],
    'link_name_prefix' => 'CPC'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://studio-api.onlytraffic.com/api/external/v1/cpc/campaigns/{public_id}/settings"

	payload := strings.NewReader("{\n  \"name\": \"Reddit push September\",\n  \"max_bid_cents\": 55,\n  \"budget_daily_cents\": 5000,\n  \"budget_total_cents\": 100000,\n  \"date_start\": \"2026-09-15\",\n  \"date_end\": null,\n  \"status\": \"active\",\n  \"freq_cap\": 3,\n  \"freq_cap_days\": 3,\n  \"blocked_placements\": [\n    \"site-1f4c9ab2\"\n  ],\n  \"link_name_prefix\": \"CPC\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://studio-api.onlytraffic.com/api/external/v1/cpc/campaigns/{public_id}/settings")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Reddit push September\",\n  \"max_bid_cents\": 55,\n  \"budget_daily_cents\": 5000,\n  \"budget_total_cents\": 100000,\n  \"date_start\": \"2026-09-15\",\n  \"date_end\": null,\n  \"status\": \"active\",\n  \"freq_cap\": 3,\n  \"freq_cap_days\": 3,\n  \"blocked_placements\": [\n    \"site-1f4c9ab2\"\n  ],\n  \"link_name_prefix\": \"CPC\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://studio-api.onlytraffic.com/api/external/v1/cpc/campaigns/{public_id}/settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Reddit push September\",\n  \"max_bid_cents\": 55,\n  \"budget_daily_cents\": 5000,\n  \"budget_total_cents\": 100000,\n  \"date_start\": \"2026-09-15\",\n  \"date_end\": null,\n  \"status\": \"active\",\n  \"freq_cap\": 3,\n  \"freq_cap_days\": 3,\n  \"blocked_placements\": [\n    \"site-1f4c9ab2\"\n  ],\n  \"link_name_prefix\": \"CPC\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "campaign_id": "cpcp_a1b2c3d4"
  }
}

{
  "success": false,
  "error": "validation_failed",
  "message": "<string>",
  "details": {},
  "retry_after": 123
}

{
  "success": false,
  "error": "validation_failed",
  "message": "<string>",
  "details": {},
  "retry_after": 123
}

{
  "success": false,
  "error": "validation_failed",
  "message": "<string>",
  "details": {},
  "retry_after": 123
}

{
  "success": false,
  "error": "validation_failed",
  "message": "<string>",
  "details": {},
  "retry_after": 123
}

{
  "success": false,
  "error": "validation_failed",
  "message": "<string>",
  "details": {},
  "retry_after": 123
}

Partial update: send only the settings you want to change. Pause and resume a campaign through status (paused / active). blocked_placements replaces the whole list; date_end: null clears the end date and link_name_prefix: null resets the prefix to CPC. Only active and paused campaigns can be edited. A completed campaign (budget or end date reached) cannot be re-activated; create a new one instead. The daily budget must stay within the total budget and date_end must stay after date_start after the change is merged.

Authorizations

X-API-Key

string

header

required

Your API key from the Studio Dashboard

Path Parameters

public_id

string

required

Resource public id. Format varies by endpoint: cplo_xxxxxxx for CPL orders, cpco_xxxxxxx for CPC orders, swpo_xxxxxxx for swap orders, cpcr_xxxxxxx for CPC creatives, revi_xxxxxxx for RevShare invoices.

Pattern: ^[a-z0-9_]+$

Body

application/json

Send only the settings you want to change. Everything else keeps its current value. null is a real value here: it clears date_end and resets link_name_prefix.

name

string

Campaign name shown in Studio.

Maximum string length: 100

Example:

"Reddit push September"

max_bid_cents

integer

Maximum bid per click, in cents (10 to 200).

Required range: 10 <= x <= 200

Example:

55

budget_daily_cents

integer

Daily budget cap, in cents: at least 2000, at most 5000000 ($50,000), and never above budget_total_cents.

Required range: 2000 <= x <= 5000000

Example:

5000

budget_total_cents

integer

Lifetime budget cap, in cents: at least 10000, at most 100000000 ($1,000,000). The campaign flips to completed when spend reaches it.

Required range: 10000 <= x <= 100000000

Example:

100000

date_start

string<date>

Scheduled start, YYYY-MM-DD or ISO 8601. A bare date is read in the Studio timezone; a value with an offset is converted.

Example:

"2026-09-15"

date_end

string<date> | null

Scheduled end, must be later than date_start. Pass null to clear the end date.

Example:

null

status

enum<string>

paused pauses the campaign, active resumes it.

Available options:

active,

paused

Example:

"active"

freq_cap

integer

Maximum impressions shown to the same visitor within freq_cap_days. 0 means uncapped.

Required range: 0 <= x <= 100

Example:

3

freq_cap_days

enum<integer>

Window the frequency cap is measured over, in days.

Available options:

1,

3,

7

Example:

3

blocked_placements

string[]

Replaces the whole list of excluded placements. Pass an empty array to unblock everything.

Maximum array length: 500

Pattern: ^site-[0-9a-f]{8}$

link_name_prefix

string | null

Prefix for the tracking-link names minted for this campaign. Pass null to reset it to CPC.

Required string length: 2 - 40

Pattern: ^[\w .\-]+$

Example:

"CPC"

Response

Updated.

success

boolean

Example:

true

data

object

Show child attributes

Overview

Platforms

Work Formats

Tools

Payments & Safety

API & MCP

Authorizations

Path Parameters

Body

Response