/

Browse the help center

Create or update site

Creates a new publisher site or updates an existing one.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/sites/update.do

Creates a new publisher site or updates an existing one. If the request includes a site ID, the existing site is updated; otherwise a new site is created. Requires ALL or SHARED level CREATE/UPDATE permission on INVENTORY (SHARED requires CAN_EDIT or IS_OWNER share type). When creating, optionally set createDefaultZone=true to auto-create a zone matching the site name. Auto-placements and default pricing may be initialized on creation. SSP sites cannot be updated through this endpoint. A new site is approved on creation when the caller holds SITES_APPROVAL; an update never changes the approval status. Fields with a console control of their own are applied only with that control's permission enabled and otherwise keep the stored value: 'active' MANAGE_SITES_ACTIVE_STATUS, 'adsHost' AD_SERVING_DOMAIN_INVENTORY, 'invocationCodeHost' INVOCATION_CODE_DOMAIN, 'piggybackStatus' PIGGYBACK_PIXEL_TRACKING, 'privateField' SET_PRIVATE, 'maskInventory' MANAGE_MASK_INVENTORY, 'cookieCollectingEnabled' SITE_COOKIE_NOCOLLECT, and the targeting, rules and per-action-limit switches their own. 'adsHost' and 'invocationCodeHost' must be one of the network's domains (see adsHosts / invocationCodeHosts), or blank for the system default. Parameters that were sent but not applied are listed in 'ignoredFields', each with its reason in 'ignoredFieldReasons'.

Form Params

createDefaultZone boolean

If true, creates a default zone with the same name as the site

true

id integer

ID of the site to update — omit to create a new site

2001

categoryId array<integer>

Publisher category IDs, comma-separated or repeated — replace the site's categories

5

actionLimitsEnabled boolean

Enable per-action conversion limits

true

active boolean

Whether the site is active

true

adsHost string

Custom ad serving domain for this site

ads.example.com

bundle string

App bundle id (com.example.app on Android, numeric ID on iOS) — only relevant when inventoryType=APP. Optional.

com.example.app

cookieCollectingEnabled boolean

Enable cookie-based visitor tracking

true

description string

Site description

High-traffic news portal

email string

Contact email for the site

publisher@example.com

enableRules boolean

Enable advanced rules engine for this site

true

enableTargeting boolean

Enable targeting rules for this site

true

impressionsByMonth string

Monthly impression volume range

_1_MILLION_50_MILLION

inventoryType string

Inventory type: WEBSITE or APP

WEBSITE

invocationCodeHost string

Custom domain for invocation code generation, up to 64 characters

ads.example.com

maskInventory boolean

Mask inventory details from advertisers

true

name string

Site name

Example News Portal

operationBetweenRuleTypes string

Logical operator between different targeting rule types (AND, OR)

AND

piggybackStatus string

Piggyback tracking status (ENABLED, DISABLED)

ENABLED

privacyPolicyEnabled boolean

Whether a privacy policy is enabled for this site

true

privateField boolean

Mark as private — hidden from marketplace/network discovery

true

schainSellerId string

Seller id for this publisher in the network's own sellers.json

1200

url string

Site URL — only relevant when inventoryType=WEBSITE, ignored for APP. Optional.

https://example.com

visitorsByMonth string

Monthly unique visitor volume range

_100K_1_MILLION

revenueShare number

Revenue share percentage (0-100) for this site

70.0

Responses

200

Site created or updated successfully

400

Bad request — invalid or missing parameters

401

Authentication error

403

Insufficient permissions

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/sites/update.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'id=2001' \
  --data-urlencode 'name=Example News Portal' \
  --data-urlencode 'active=true' \
  --data-urlencode 'createDefaultZone=true'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/sites/update.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"id": "2001", "name": "Example News Portal", "active": "true", "createDefaultZone": "true"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/sites/update.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"id":"2001","name":"Example News Portal","active":"true","createDefaultZone":"true"}),
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/sites/update.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("id=2001&name=Example%20News%20Portal&active=true&createDefaultZone=true"))
    .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/sites/update.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["id"] = "2001", ["name"] = "Example News Portal", ["active"] = "true", ["createDefaultZone"] = "true" });

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/sites/update.do", strings.NewReader(`id=2001&name=Example%20News%20Portal&active=true&createDefaultZone=true`))
	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/sites/update.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, 'id=2001&name=Example%20News%20Portal&active=true&createDefaultZone=true');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/sites/update.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('id' => "2001", 'name' => "Example News Portal", 'active' => "true", 'createDefaultZone' => "true")

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