Create a new label

Creates a new label with the specified properties.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/label/create.do

Creates a new label with the specified properties. The JSON request body must include 'value' (label name), and 'defaultLabelObjectType' (1=Banner or 2=Placement) when 'defaultLabel' is true. Optionally include 'defaultLabel' (boolean) and 'defaultLabelPlacementTypes' (array of placement type IDs). Returns validation errors if the value is empty or the object type is invalid. Returns an error if a label with the same value already exists. Requires the LABELS_MANAGEMENT permission.

Body

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

{
  "id": "100",
  "value": "Sports",
  "defaultLabel": "false",
  "defaultLabelObjectType": "1"
}

Responses

200

Label created successfully

400

Invalid value, object type or placement type ids (per-field errors), or a label with that value already exists

401

Authentication error

403

No access to labels management

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/label/create.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "100",
  "value": "Sports",
  "defaultLabel": "false",
  "defaultLabelObjectType": "1"
}'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/label/create.do", headers={"X-Api-Key": "YOUR_API_KEY"}, json={
    "id": "100",
    "value": "Sports",
    "defaultLabel": "False",
    "defaultLabelObjectType": "1"
})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/label/create.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "id": "100",
    "value": "Sports",
    "defaultLabel": "false",
    "defaultLabelObjectType": "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/label/create.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"id\":\"100\",\"value\":\"Sports\",\"defaultLabel\":\"false\",\"defaultLabelObjectType\":\"1\"}"))
    .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/label/create.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new StringContent("{\"id\":\"100\",\"value\":\"Sports\",\"defaultLabel\":\"false\",\"defaultLabelObjectType\":\"1\"}", 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/label/create.do", strings.NewReader(`{"id":"100","value":"Sports","defaultLabel":"false","defaultLabelObjectType":"1"}`))
	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/label/create.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":"100","value":"Sports","defaultLabel":"false","defaultLabelObjectType":"1"}');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/label/create.do")
request = Net::HTTP::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/json'
request.body = "{\"id\":\"100\",\"value\":\"Sports\",\"defaultLabel\":\"false\",\"defaultLabelObjectType\":\"1\"}"

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