Update an existing label

Updates the label identified by labelId with the provided JSON properties.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/label/{labelId}/update.do

Updates the label identified by labelId with the provided JSON properties. The request body may include 'value', 'defaultLabel', 'defaultLabelObjectType', and 'defaultLabelPlacementTypes'. If the label name is changed, uniqueness is validated against existing labels. Every property not sent keeps its stored value. Requires the LABELS_MANAGEMENT permission.

Path Params

labelId integer required

Unique numeric identifier of the label to update

100

Body

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

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

Responses

200

Label updated 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

404

Label not found

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/label/100/update.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/100/update.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/100/update.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/100/update.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/100/update.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/100/update.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/100/update.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/100/update.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