Add rule matches to rule

Adds new rule match entries to an existing rule identified by its numeric ID.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/rule/{ruleId}/matches/add.do

Adds new rule match entries to an existing rule identified by its numeric ID. The request body must be a JSON array of rule match objects, each containing category IDs (AdvertisingCategory for CAMPAIGN rules, PublisherCategory for INVENTORY rules), label IDs, a logical operator (AND/OR), and an include/exclude flag. Duplicate entries (matching existing rule matches or duplicates within the request) are rejected with validation errors. Returns a JSON object with 'success: true' on completion, or validation error details. Requires authentication and UPDATE permission on the RULES static ACL identity.

Path Params

ruleId integer required

The unique numeric identifier of the rule to add matches to

200

Body

A JSON body. An example, built from the field definitions:

[
  {
    "id": "301",
    "include": "true",
    "operator": "AND"
  }
]

Responses

200

Rule matches added successfully

400

Bad request — invalid or missing parameters

401

Unauthorized - authentication error

403

Forbidden - insufficient permissions

404

Rule not found

500

Internal server error

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/rule/200/matches/add.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "id": "301",
    "include": "true",
    "operator": "AND"
  }
]'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/rule/200/matches/add.do", headers={"X-Api-Key": "YOUR_API_KEY"}, json=[
    {
        "id": "301",
        "include": "True",
        "operator": "AND"
    }
])
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/rule/200/matches/add.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' },
  body: JSON.stringify([
    {
      "id": "301",
      "include": "true",
      "operator": "AND"
    }
  ]),
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/rule/200/matches/add.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("[{\"id\":\"301\",\"include\":\"true\",\"operator\":\"AND\"}]"))
    .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/rule/200/matches/add.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new StringContent("[{\"id\":\"301\",\"include\":\"true\",\"operator\":\"AND\"}]", Encoding.UTF8, "application/json");

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/rule/200/matches/add.do", strings.NewReader(`[{"id":"301","include":"true","operator":"AND"}]`))
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/json")

	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/rule/200/matches/add.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/json"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '[{"id":"301","include":"true","operator":"AND"}]');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/rule/200/matches/add.do")
request = Net::HTTP::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/json'
request.body = "[{\"id\":\"301\",\"include\":\"true\",\"operator\":\"AND\"}]"

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