Set the custom parameter recording policy

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/custom-parameter-policy.do

What reaches the analytics and conversion parameter logs: ANY records every custom parameter except the registered ones with recordInAnalytics false; ONLY_VERIFIED records only registered parameters with recordInAnalytics true. Targeting, macros and click/conversion forwarding never depend on it. Refused while the policy is LEGACY: move the Analytics configuration list first (custom-parameter-policy/adopt-legacy). Logs follow within a minute. Requires the CUSTOM_PARAMETERS admin permission (Admin → Targeting presets → Custom parameters).

Form Params

policy string required

ANY or ONLY_VERIFIED

ONLY_VERIFIED

Responses

200

{policy}

400

policy is not ANY or ONLY_VERIFIED

401

Authentication error

403

Insufficient permissions, naming the missing one

409

The Analytics configuration list still decides; adopt it first

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/custom-parameter-policy.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'policy=ONLY_VERIFIED'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/custom-parameter-policy.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"policy": "ONLY_VERIFIED"})
print(response.json())

Node Request

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

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

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/custom-parameter-policy.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("policy=ONLY_VERIFIED"))
    .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/custom-parameter-policy.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["policy"] = "ONLY_VERIFIED" });

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/custom-parameter-policy.do", strings.NewReader(`policy=ONLY_VERIFIED`))
	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/custom-parameter-policy.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, 'policy=ONLY_VERIFIED');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/custom-parameter-policy.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('policy' => "ONLY_VERIFIED")

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