Update a publishing category

Renames a publishing category, or changes whether it is PUBLIC or INTERNAL.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/categories/publishing/{categoryId}/update.do

Renames a publishing category, or changes whether it is PUBLIC or INTERNAL. Both fields are optional and what is not sent keeps its value. The sites and placements already classified with the category keep it: only its name and type change. Invalid values come back per field in 'errors'. Requires the PUBLISHER_CATEGORIES_MANAGEMENT admin permission (Admin -> Inventory Categories).

Path Params

categoryId integer required

Publishing category id

5

Form Params

name string

New name, unique within its list (compared without case), at most 128 characters. Omit to keep the current one

Automotive

type string

PUBLIC or INTERNAL (or their integer ids 1 and 2). Omit to keep the current one

PUBLIC

Responses

200

{success, category: {id, name, type}}

400

Invalid request, each problem named in errors by field (name, type)

401

Authentication error

403

Without the PUBLISHER_CATEGORIES_MANAGEMENT admin permission

404

No publishing category with this id

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/categories/publishing/5/update.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'name=Automotive' \
  --data-urlencode 'type=PUBLIC'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/categories/publishing/5/update.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"name": "Automotive", "type": "PUBLIC"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/categories/publishing/5/update.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"name":"Automotive","type":"PUBLIC"}),
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

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

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/categories/publishing/5/update.do", strings.NewReader(`name=Automotive&type=PUBLIC`))
	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/categories/publishing/5/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/x-www-form-urlencoded"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'name=Automotive&type=PUBLIC');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/categories/publishing/5/update.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('name' => "Automotive", 'type' => "PUBLIC")

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