/

Browse the help center

Create or update advertiser — put

Creates a new advertiser when the 'id' request parameter is absent, or updates an existing advertiser when 'id' is provided.

Reference

PUT https://YOUR-NETWORK-DOMAIN/rest-api/advertisers/update.do

Creates a new advertiser when the 'id' request parameter is absent, or updates an existing advertiser when 'id' is provided. Accepts advertiser fields (name, contactName, contactEmail, description, active, categoryId, adomain, selfServeCpmFloorAdjustment) as form parameters. Fields the caller has no enabled permission for are ignored, keeping the stored value: 'adomain' needs ADVERTISER_ADOMAIN, 'active' MANAGE_ADVERTISERS_ACTIVE_STATUS, 'privateField' SET_PRIVATE, 'confirmationDelay', 'preliminaryConfirmationDays' and 'lastConfirmedDate' (yyyy-MM-dd, the date up to which revenue counts as confirmed under the LAST_CONFIRMED_DATE policy; empty clears it) MANAGE_COMPLETENESS_DELAY_INVENTORY, 'selfServeCpmFloorAdjustment' (0-10000) SELF_SERVE_CPM_FLOOR, and 'adsHost' AD_SERVING_DOMAIN_CAMPAIGNS - without it a new advertiser takes the caller's own ad-serving domain. With it, 'adsHost' must be one of the network's ad-serving domains, or blank for the system default. On success, returns a JSON object with {"success":true, "id": advertiserId}. On validation or permission failure, returns {"success":false} with optional error details. When updating, if the active status changes, corresponding activation/deactivation events are fired. If 'enableLimits' is true and the advertiser has no limits yet, an AdvertiserLimit record is created automatically. Parameters that were sent but not applied are listed in 'ignoredFields', each with its reason in 'ignoredFieldReasons'.

Form Params

id integer

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

1001

categoryId array<integer>

Advertising category IDs, comma-separated or repeated — replace the advertiser's categories. At least one is required when the ADVERTISER_CATEGORIES_REQUIRED permission is on

3

actionLimitsEnabled boolean

Enable per-action conversion limits

true

active boolean

Set to true to activate or false to deactivate the advertiser.

true

adomain string

Advertiser's own brand domain, published to buyers as the OpenRTB adomain for block-list matching. Not a tracking or redirect domain.

acme.com

adsHost string

Custom ad serving domain for this advertiser

ads.example.com

confirmationDelay string

How recent revenue is treated before the advertiser confirms it: DEFAULT — the network's default confirmation status; NONE — always confirmed; LAST_N_DAYS — the last preliminaryConfirmationDays days stay unconfirmed; LAST_CONFIRMED_DATE — everything after the advertiser's last confirmed date stays unconfirmed

DEFAULT

contactEmail string

Contact email address

john@acme.com

contactName string

Contact person name

John Smith

description string

Advertiser description

Premium brand advertiser

enablePriceAdjusting boolean

Whether price adjustment rules are enabled for this advertiser

false

enableRules boolean

Enable advanced rules engine for this advertiser

true

enableTargeting boolean

Enable targeting rules for this advertiser

true

lastConfirmedDate string

Date up to which the advertiser's revenue counts as confirmed under the LAST_CONFIRMED_DATE policy, yyyy-MM-dd; empty clears it. Needs MANAGE_COMPLETENESS_DELAY_INVENTORY

2026-08-31

name string

Advertiser name

Acme Corp

operationBetweenRuleTypes string

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

AND

preliminaryConfirmationDays integer

Number of days for preliminary conversion confirmation, 0 to 365

7

privateField boolean

Mark as private — hidden from marketplace discovery

true

selfServeCpmFloorAdjustment integer

Self-serve CPM floor adjustment percentage (0-10000, where 100 = no adjustment)

100

enableLimits boolean

Set to true to automatically create an AdvertiserLimit record for this advertiser if one does not already exist. Requires MANAGE_CAPPING_AND_LIMITATIONS permission.

true

Responses

200

Advertiser created/updated. Response contains 'id' field.

400

Bad request — invalid or missing parameters

401

Unauthorized — authentication failed or missing credentials

403

Insufficient permissions

404

Advertiser not found or deleted (update only)

Language

cURL Request

curl --request PUT \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/advertisers/update.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'id=1001' \
  --data-urlencode 'name=Acme Corp' \
  --data-urlencode 'active=true' \
  --data-urlencode 'categoryId=3'

Python Request

import requests

response = requests.request("PUT", "https://YOUR-NETWORK-DOMAIN/rest-api/advertisers/update.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"id": "1001", "name": "Acme Corp", "active": "true", "categoryId": "3"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/advertisers/update.do', {
  method: 'PUT',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"id":"1001","name":"Acme Corp","active":"true","categoryId":"3"}),
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

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

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("PUT", "https://YOUR-NETWORK-DOMAIN/rest-api/advertisers/update.do", strings.NewReader(`id=1001&name=Acme%20Corp&active=true&categoryId=3`))
	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/advertisers/update.do");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY", "Content-Type: application/x-www-form-urlencoded"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'id=1001&name=Acme%20Corp&active=true&categoryId=3');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/advertisers/update.do")
request = Net::HTTP::Put.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/x-www-form-urlencoded'
request.set_form_data('id' => "1001", 'name' => "Acme Corp", 'active' => "true", 'categoryId' => "3")

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