Add an advertising category

Adds an advertising category to the network's list, the one advertisers are classified with.

Reference

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

Adds an advertising category to the network's list, the one advertisers are classified with. 'name' is required and must not be taken by another advertising category; 'type' defaults to PUBLIC. Invalid values come back per field in 'errors'. The answer is the stored category, in the shape the single-category read returns. Requires the ADVERTISING_CATEGORIES_MANAGEMENT admin permission (Admin -> Advertising Categories).

Form Params

name string required

Category name, unique within its list (advertising or publishing categories, compared without case), at most 128 characters

Automotive

type string

PUBLIC or INTERNAL (or their integer ids 1 and 2). Defaults to PUBLIC

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 ADVERTISING_CATEGORIES_MANAGEMENT admin permission

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/categories/advertising/create.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/advertising/create.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/advertising/create.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/advertising/create.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/advertising/create.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/advertising/create.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/advertising/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/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/advertising/create.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