Create or edit additional entity field

Creates a new additional entity field or updates an existing one.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/additional-entity-fields-configuration/edit.do

Creates a new additional entity field or updates an existing one. When 'id' parameter is provided, the existing field with that ID is loaded and updated; otherwise a new field is created. The field data (name, title, entityType) is submitted as form parameters and validated server-side. On success, the saved field is returned inside the JSON response under the 'field' key. An action log entry is recorded for audit purposes. Requires the ADDITIONAL_ENTITIES_FIELDS_CONFIGURATION admin permission.

Form Params

id integer

ID of the field configuration to edit — omit to create a new one

7

entityType string

Entity type this field applies to (BANNER, CAMPAIGN, PLACEMENT, SITE, ZONE, ADVERTISER)

CAMPAIGN

name string

Machine-readable field name (e.g., 'custom_field_1')

custom_field_1

title string

Human-readable field title displayed in the UI

Custom Field 1

Responses

200

JSON with 'success: true' and the saved field object, or validation errors if input is invalid

400

Bad request — invalid or missing parameters

401

Authentication error - invalid hash, timestamp, or username

403

Forbidden - user lacks ADDITIONAL_ENTITIES_FIELDS_CONFIGURATION permission

404

No field with the id sent

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/additional-entity-fields-configuration/edit.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'id=7' \
  --data-urlencode 'name=custom_field_1' \
  --data-urlencode 'entityType=CAMPAIGN' \
  --data-urlencode 'title=Custom Field 1'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/additional-entity-fields-configuration/edit.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"id": "7", "name": "custom_field_1", "entityType": "CAMPAIGN", "title": "Custom Field 1"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/additional-entity-fields-configuration/edit.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"id":"7","name":"custom_field_1","entityType":"CAMPAIGN","title":"Custom Field 1"}),
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/additional-entity-fields-configuration/edit.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("id=7&name=custom_field_1&entityType=CAMPAIGN&title=Custom%20Field%201"))
    .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/additional-entity-fields-configuration/edit.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["id"] = "7", ["name"] = "custom_field_1", ["entityType"] = "CAMPAIGN", ["title"] = "Custom Field 1" });

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/additional-entity-fields-configuration/edit.do", strings.NewReader(`id=7&name=custom_field_1&entityType=CAMPAIGN&title=Custom%20Field%201`))
	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/additional-entity-fields-configuration/edit.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, 'id=7&name=custom_field_1&entityType=CAMPAIGN&title=Custom%20Field%201');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/additional-entity-fields-configuration/edit.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('id' => "7", 'name' => "custom_field_1", 'entityType' => "CAMPAIGN", 'title' => "Custom Field 1")

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