Remove rules group from banner

Permanently deletes a targeting rules group from the specified banner.

Reference

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

Permanently deletes a targeting rules group from the specified banner. The rule group is identified by the 'ruleGroupId' query parameter, and the banner by its path ID. After removal, the rules in that group will no longer affect ad serving for this banner. The response is a JSON object with 'success: true'. Requires UPDATE permission on the banner's parent advertiser campaign share and CAMPAIGN_RULES_MANAGEMENT permission. 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 to remove the rules group from

7890

Form Params

ruleGroupId integer required

The unique numeric identifier of the rules group to remove

50

Responses

200

Rules group removed successfully

400

Bad request - ruleGroupId is missing

401

Unauthorized - authentication error

403

Forbidden - insufficient permissions

404

Banner not found, or the rules group is not one of its groups

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/rules/banner/7890/remove.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'ruleGroupId=50'

Python Request

import requests

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

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/rules/banner/7890/remove.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"ruleGroupId":"50"}),
});

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/remove.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("ruleGroupId=50"))
    .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/remove.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["ruleGroupId"] = "50" });

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/rules/banner/7890/remove.do", strings.NewReader(`ruleGroupId=50`))
	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/rules/banner/7890/remove.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, 'ruleGroupId=50');

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/remove.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('ruleGroupId' => "50")

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