/

Browse the help center

Create campaign

Creates a new campaign under the specified advertiser and returns the created campaign details.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/campaign/create.do

Creates a new campaign under the specified advertiser and returns the created campaign details. The advertiser must exist and not be deleted. If the active status is not provided, the system default activity status is used. Supports all campaign fields including name, optimization settings, autolinking categories, labels, priority, and self-serve type. Sends the campaign-created notification. The response has the same shape as /rest-api/campaign/{campaignId}.do; its status array reads status-not-active until the campaign serves traffic. Fields the console's campaign card shows only with a permission are applied only with it enabled: weight (MANAGE_CAMPAIGN_WEIGHT), priority (MANAGE_PRIORITY), ctrOptimization (SET_CTR_OPTIMIZATION), cpaOptimization and cpaOptimizationActions (SET_CPA_OPTIMIZATION), ecpmOptimization (SET_ECPM_OPTIMIZATION), exchangeRate and allowImpressionAndClicksPricingUrlOverriding (EVENT_TRACKING_PRICE_OVERRIDING), selfServeCampaignType (SELF_SERVE_CAMPAIGN_TYPES), onlyOneBannerPerPage (SET_DONT_SHOW_BANNERS_OF_ONE_CAMPAIGN_ON_SAME_PAGE), onlyThisCampaignOnPage (SET_SHOW_BANNERS_OF_ONE_CAMPAIGN_ON_SAME_PAGE), showBannersOfOneCampaignAtTheSamePageAlias (SET_SHOW_BANNERS_OF_ONE_CAMPAIGN_ON_SAME_PAGE_ALIAS), campaignAliasForActionTracking (SET_CAMPAIGN_ALIAS_FOR_ACTION_TRACKING), allowNewPlacementsAutolinking and autolinkCategories (AUTO_LINKING_SETTINGS), allowUseForTemplate and targetTemplateName (TARGETING_TEMPLATE), labels and labelUpdateType (CAMPAIGN_LABELS), and enableActions, allowActionPricingUrlOverriding and maxActionPriceOverride (MANAGE_ACTION_TRACKING). Without the permission the field keeps its value and the rest of the request is saved. Parameters that were sent but not applied are listed in 'ignoredFields', each with its reason in 'ignoredFieldReasons'.

Form Params

advertiserId integer required

ID of the advertiser under which to create the campaign

1001

autolinkCategories array<integer>

IDs of the publisher categories whose new placements the campaign auto-links to, comma-separated or repeated — with none set, only banners carrying auto-link labels link, by label

5

active boolean

Whether the campaign is active and serving ads

true

allowActionPricingUrlOverriding boolean

Allow overriding action pricing URLs at the campaign level

true

allowImpressionAndClicksPricingUrlOverriding boolean

Allow overriding impression and click pricing URLs

true

allowNewPlacementsAutolinking boolean

When true, newly created placements matching the campaign's categories are automatically linked

true

allowUseForTemplate boolean

Whether this campaign can be used as a template

true

autoTagLandingUrl boolean

Whether the click redirect appends the click id to the landing page, so the macro does not have to be pasted into every creative. Off by default - it rewrites a URL the advertiser owns

true

campaignAliasForActionTracking string

Custom alias for action tracking attribution, up to 64 characters

summer-sale

cpaOptimization boolean

Enable CPA-based optimization for banner delivery

true

cpaOptimizationActions array<integer>

Set of actions used for CPA optimization — IDs of the action entities, comma-separated or as repeated parameters

12

ctrOptimization boolean

Enable CTR-based optimization for banner delivery

true

description string

Campaign description text

Q3 promotion for returning mobile users

ecpmOptimization boolean

Enable eCPM-based optimization for banner delivery

true

enableActions boolean

Enable conversion action tracking for this campaign

true

exchangeRate number

Currency conversion multiplier from campaign currency to the network's base currency (range 0.001–999.999)

1.0

labelUpdateType string

How labels are applied. Allowed values: add (append), overwrite (replace all existing), remove (delete specified), clear (remove all)

ADD

labels array<string>

Label names to associate with this campaign

Q3 Retargeting

maxActionPriceOverride number

Upper bound, in campaign currency, on the conversion payout a tracking URL may set. A higher payout is clamped to this value and the conversion is still counted. Omit to keep the current bound, send it empty to remove it (0 is a bound of 0); 0 to 9999999.9999; only consulted when allowActionPricingUrlOverriding is enabled

50

name string

Campaign display name, up to 512 characters, never blank. Left out on create, the campaign is named "Campaign <id>".

Summer 2025 Campaign

onlyOneBannerPerPage boolean

Restrict delivery to one banner per page view

true

onlyThisCampaignOnPage boolean

Restrict page to show only banners from this campaign

true

priority string

Delivery priority level for this campaign. Allowed values: STANDARD_HIGH, STANDARD_MEDIUM, STANDARD_LOW, PREMIUM, NON_GUARANTEED, HOUSE_ADS

STANDARD_MEDIUM

selfServeCampaignType string

Self-serve campaign type classification

BANNER_DESKTOP

showBannersOfOneCampaignAtTheSamePageAlias string

Alias used for one-campaign-per-page restriction, up to 64 characters

summer-sale

targetTemplateName string

Name of the targeting template to apply, up to 50 characters

Mobile US targeting

weight integer

Relative delivery weight (0-32767) for weighted rotation

50

Responses

200

Campaign created successfully

400

Bad request

401

Authentication error

403

Insufficient permissions to create campaign

404

Advertiser not found

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/campaign/create.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'advertiserId=1001' \
  --data-urlencode 'name=Summer 2025 Campaign' \
  --data-urlencode 'autolinkCategories=5' \
  --data-urlencode 'campaignAliasForActionTracking=summer-sale'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/campaign/create.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"advertiserId": "1001", "name": "Summer 2025 Campaign", "autolinkCategories": "5", "campaignAliasForActionTracking": "summer-sale"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/campaign/create.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"advertiserId":"1001","name":"Summer 2025 Campaign","autolinkCategories":"5","campaignAliasForActionTracking":"summer-sale"}),
});

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/create.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("advertiserId=1001&name=Summer%202025%20Campaign&autolinkCategories=5&campaignAliasForActionTracking=summer-sale"))
    .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/create.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["advertiserId"] = "1001", ["name"] = "Summer 2025 Campaign", ["autolinkCategories"] = "5", ["campaignAliasForActionTracking"] = "summer-sale" });

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/create.do", strings.NewReader(`advertiserId=1001&name=Summer%202025%20Campaign&autolinkCategories=5&campaignAliasForActionTracking=summer-sale`))
	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/create.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, 'advertiserId=1001&name=Summer%202025%20Campaign&autolinkCategories=5&campaignAliasForActionTracking=summer-sale');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/campaign/create.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('advertiserId' => "1001", 'name' => "Summer 2025 Campaign", 'autolinkCategories' => "5", 'campaignAliasForActionTracking' => "summer-sale")

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