/

Browse the help center

Create or update zone

Creates a new zone or updates an existing one under a publisher site.

Reference

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

Creates a new zone or updates an existing one under a publisher site. To update, provide the zone's numeric ID; to create, omit the ID. The zone name is mandatory, while description is optional. For new zones, a valid siteId is required to specify which site the zone belongs to, and the caller needs INVENTORY CREATE; on an update, a different siteId moves the zone and needs UPDATE on both the site it leaves and the site it joins; its placements keep their keys, so their published ad tags keep working. If the user has the MANAGE_ZONES_ACTIVE_STATUS permission, the zone's active status can also be toggled. Activation and deactivation events are logged separately. Parameters that were sent but not applied are listed in 'ignoredFields', each with its reason in 'ignoredFieldReasons'.

Form Params

id integer

ID of the zone to update — omit (or 0) to create a new zone

3001

siteId integer

ID of the site the zone belongs to — needed when creating; on update, moves the zone to this site

2001

active boolean

Whether the zone is active

true

description string

Zone description

Groups all content-area placements

enableRules boolean

Whether rule-based optimization is enabled for this zone

false

enableTargeting boolean

Enable pretargeting rules for this zone

true

name string

Zone name

Main Content Zone

operationBetweenRuleTypes string

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

AND

Responses

200

Zone created or updated successfully

400

Bad request — invalid or missing parameters

401

Authentication error

403

Insufficient privileges to manage zones

404

Associated site not found

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/zones/update.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'id=3001' \
  --data-urlencode 'siteId=2001' \
  --data-urlencode 'name=Main Content Zone' \
  --data-urlencode 'active=true' \
  --data-urlencode 'description=Groups all content-area placements'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/zones/update.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"id": "3001", "siteId": "2001", "name": "Main Content Zone", "active": "true", "description": "Groups all content-area placements"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/zones/update.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"id":"3001","siteId":"2001","name":"Main Content Zone","active":"true","description":"Groups all content-area placements"}),
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

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

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/zones/update.do", strings.NewReader(`id=3001&siteId=2001&name=Main%20Content%20Zone&active=true&description=Groups%20all%20content-area%20placements`))
	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/zones/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=3001&siteId=2001&name=Main%20Content%20Zone&active=true&description=Groups%20all%20content-area%20placements');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/zones/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' => "3001", 'siteId' => "2001", 'name' => "Main Content Zone", 'active' => "true", 'description' => "Groups all content-area placements")

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