Set an entity's custom field values

Sets custom (additional) field values on the entity, as saving the console's Basic Info card does.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/additional-fields/{entityType}/{entityId}.do

Sets custom (additional) field values on the entity, as saving the console's Basic Info card does. The JSON body maps a field to its new value; a field is named by its id or by its name, for example {"7": "Q3 push", "cost_center": "EU-42"}. Only the fields sent change. A value is free text of at most 255 characters; an empty string clears it. A field that does not exist, or belongs to another entity type, refuses the whole request and nothing is saved. Needs update rights on the entity: the advertiser's share for an advertiser, campaign or banner, the site's share for a site, zone or placement. Answers with the entity's values after the save, in the shape of the GET.

Path Params

entityType string required

Entity type the fields belong to

CAMPAIGN

entityId integer required

Id of the advertiser, campaign, banner, site, zone or placement

2001

Body

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

{}

Responses

200

Saved; 'fields' lists {id, name, title, value} for each field of the entity type

400

Empty body, an unknown field, a field of another entity type, or a value longer than 255 characters

401

Authentication error

403

No update rights on the entity

404

The entity does not exist or is deleted

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/additional-fields/CAMPAIGN/2001.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "cost_center": "EU-42"
}'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/additional-fields/CAMPAIGN/2001.do", headers={"X-Api-Key": "YOUR_API_KEY"}, json={
    "cost_center": "EU-42"
})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/additional-fields/CAMPAIGN/2001.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "cost_center": "EU-42"
  }),
});

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-fields/CAMPAIGN/2001.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"cost_center\":\"EU-42\"}"))
    .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-fields/CAMPAIGN/2001.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new StringContent("{\"cost_center\":\"EU-42\"}", 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/additional-fields/CAMPAIGN/2001.do", strings.NewReader(`{"cost_center":"EU-42"}`))
	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/additional-fields/CAMPAIGN/2001.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, '{"cost_center":"EU-42"}');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/additional-fields/CAMPAIGN/2001.do")
request = Net::HTTP::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/json'
request.body = "{\"cost_center\":\"EU-42\"}"

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