Disable banner rules

Deactivates the targeting rules engine for the specified banner, so its rule groups no longer affect ad serving decisions.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/rules/banner/{bannerId}/disable.do

Deactivates the targeting rules engine for the specified banner, so its rule groups no longer affect ad serving decisions. The banner is identified by its numeric ID in the URL path. The response is a JSON object with 'success: true' on success. Requires UPDATE permission on the banner's parent advertiser campaign share and CAMPAIGN_RULES_MANAGEMENT permission. The action is logged for audit purposes. POST only: a GET answers 405, since a state change over GET can be triggered by a prefetch or an embedded link.

Path Params

bannerId integer required

The unique numeric identifier of the banner whose targeting rules should be disabled

7890

Responses

200

Rules disabled successfully

400

Bad request — invalid or missing parameters

401

Unauthorized - authentication error

403

Forbidden - insufficient permissions

404

Banner not found

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/rules/banner/7890/disable.do' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/rules/banner/7890/disable.do", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/rules/banner/7890/disable.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/rules/banner/7890/disable.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .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/rules/banner/7890/disable.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/rules/banner/7890/disable.do", nil)
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")

	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/rules/banner/7890/disable.do");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY"]);

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/rules/banner/7890/disable.do")
request = Net::HTTP::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'

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