Skip to main content
Support

Create a category

POST https://api.helpdocs.io/v1/category

Example request

Generated
Parameters
curl -X POST https://api.helpdocs.io/v1/category \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "parent_category_id": "string",
    "is_featured": true,
    "icon": "string",
    "enforce_permissions": true,
    "permission_groups": [
      "string"
    ],
    "language_code": "string",
    "title": "string",
    "description": "string",
    "slug": "string",
    "multilingual": [
      {
        "language_code": "string",
        "title": "string",
        "description": "string",
        "slug": "string"
      }
    ]
  }'
curl -X POST https://api.helpdocs.io/v1/category \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{}'
const url = "https://api.helpdocs.io/v1/category";

const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "parent_category_id": "string",
    "is_featured": true,
    "icon": "string",
    "enforce_permissions": true,
    "permission_groups": [
      "string"
    ],
    "language_code": "string",
    "title": "string",
    "description": "string",
    "slug": "string",
    "multilingual": [
      {
        "language_code": "string",
        "title": "string",
        "description": "string",
        "slug": "string"
      }
    ]
  }),
});

const data = await response.json();
console.log(data);
const url = "https://api.helpdocs.io/v1/category";

const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({}),
});

const data = await response.json();
console.log(data);
const url = "https://api.helpdocs.io/v1/category";

const options: RequestInit = {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "parent_category_id": "string",
    "is_featured": true,
    "icon": "string",
    "enforce_permissions": true,
    "permission_groups": [
      "string"
    ],
    "language_code": "string",
    "title": "string",
    "description": "string",
    "slug": "string",
    "multilingual": [
      {
        "language_code": "string",
        "title": "string",
        "description": "string",
        "slug": "string"
      }
    ]
  }),
};

const response = await fetch(url, options);

const data: unknown = await response.json();
console.log(data);
const url = "https://api.helpdocs.io/v1/category";

const options: RequestInit = {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({}),
};

const response = await fetch(url, options);

const data: unknown = await response.json();
console.log(data);
import requests

url = "https://api.helpdocs.io/v1/category"

headers = {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json",
}

payload = {
    "parent_category_id": "string",
    "is_featured": True,
    "icon": "string",
    "enforce_permissions": True,
    "permission_groups": [
        "string",
    ],
    "language_code": "string",
    "title": "string",
    "description": "string",
    "slug": "string",
    "multilingual": [
        {
            "language_code": "string",
            "title": "string",
            "description": "string",
            "slug": "string",
        },
    ],
}

response = requests.post(url, headers=headers, json=payload)

print(response.json())
import requests

url = "https://api.helpdocs.io/v1/category"

headers = {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json",
}

payload = {}

response = requests.post(url, headers=headers, json=payload)

print(response.json())
<?php

$ch = curl_init("https://api.helpdocs.io/v1/category");

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOUR_TOKEN",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => json_encode([
        "parent_category_id" => "string",
        "is_featured" => true,
        "icon" => "string",
        "enforce_permissions" => true,
        "permission_groups" => [
            "string",
        ],
        "language_code" => "string",
        "title" => "string",
        "description" => "string",
        "slug" => "string",
        "multilingual" => [
            [
                "language_code" => "string",
                "title" => "string",
                "description" => "string",
                "slug" => "string",
            ],
        ],
    ]),
]);

$response = curl_exec($ch);

print_r(json_decode($response, true));
<?php

$ch = curl_init("https://api.helpdocs.io/v1/category");

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOUR_TOKEN",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => json_encode(new stdClass()),
]);

$response = curl_exec($ch);

print_r(json_decode($response, true));
package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	body := strings.NewReader(`{
  "parent_category_id": "string",
  "is_featured": true,
  "icon": "string",
  "enforce_permissions": true,
  "permission_groups": [
    "string"
  ],
  "language_code": "string",
  "title": "string",
  "description": "string",
  "slug": "string",
  "multilingual": [
    {
      "language_code": "string",
      "title": "string",
      "description": "string",
      "slug": "string"
    }
  ]
}`)

	req, err := http.NewRequest(http.MethodPost, "https://api.helpdocs.io/v1/category", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer YOUR_TOKEN")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(data))
}
package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	body := strings.NewReader("{}")

	req, err := http.NewRequest(http.MethodPost, "https://api.helpdocs.io/v1/category", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer YOUR_TOKEN")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(data))
}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();

        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.helpdocs.io/v1/category"))
            .header("Authorization", "Bearer YOUR_TOKEN")
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString("""
                {
                  "parent_category_id": "string",
                  "is_featured": true,
                  "icon": "string",
                  "enforce_permissions": true,
                  "permission_groups": [
                    "string"
                  ],
                  "language_code": "string",
                  "title": "string",
                  "description": "string",
                  "slug": "string",
                  "multilingual": [
                    {
                      "language_code": "string",
                      "title": "string",
                      "description": "string",
                      "slug": "string"
                    }
                  ]
                }"""))
            .build();

        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();

        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.helpdocs.io/v1/category"))
            .header("Authorization", "Bearer YOUR_TOKEN")
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString("""
                {}"""))
            .build();

        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}
require "json"
require "net/http"

uri = URI("https://api.helpdocs.io/v1/category")

request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer YOUR_TOKEN"
request["Content-Type"] = "application/json"
request.body = JSON.generate({
  "parent_category_id" => "string",
  "is_featured" => true,
  "icon" => "string",
  "enforce_permissions" => true,
  "permission_groups" => [
    "string",
  ],
  "language_code" => "string",
  "title" => "string",
  "description" => "string",
  "slug" => "string",
  "multilingual" => [
    {
      "language_code" => "string",
      "title" => "string",
      "description" => "string",
      "slug" => "string",
    },
  ],
})

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

pp JSON.parse(response.body)
require "json"
require "net/http"

uri = URI("https://api.helpdocs.io/v1/category")

request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer YOUR_TOKEN"
request["Content-Type"] = "application/json"
request.body = JSON.generate({})

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

pp JSON.parse(response.body)
using System.Text;

var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Post, "https://api.helpdocs.io/v1/category");
request.Headers.Add("Authorization", "Bearer YOUR_TOKEN");
request.Content = new StringContent(
    """
    {
      "parent_category_id": "string",
      "is_featured": true,
      "icon": "string",
      "enforce_permissions": true,
      "permission_groups": [
        "string"
      ],
      "language_code": "string",
      "title": "string",
      "description": "string",
      "slug": "string",
      "multilingual": [
        {
          "language_code": "string",
          "title": "string",
          "description": "string",
          "slug": "string"
        }
      ]
    }
    """,
    Encoding.UTF8,
    "application/json");

var response = await client.SendAsync(request);

Console.WriteLine(await response.Content.ReadAsStringAsync());
using System.Text;

var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Post, "https://api.helpdocs.io/v1/category");
request.Headers.Add("Authorization", "Bearer YOUR_TOKEN");
request.Content = new StringContent(
    """
    {}
    """,
    Encoding.UTF8,
    "application/json");

var response = await client.SendAsync(request);

Console.WriteLine(await response.Content.ReadAsStringAsync());

Responses

{
  "category": {
    "category_id": "string",
    "account_id": "string",
    "parent_category_id": "string",
    "title": "string",
    "description": "string",
    "slug": "string",
    "is_featured": true,
    "icon": "string",
    "external_id": "string",
    "multilingual": [
      {
        "language_code": "string",
        "title": "string",
        "description": "string",
        "slug": "string"
      }
    ],
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-01-15T09:30:00Z",
    "permission_groups": [
      "string"
    ],
    "enforce_permissions": true,
    "url": "string",
    "relative_url": "string",
    "live_article_count": 1,
    "archived_article_count": 1,
    "name_only": true
  }
}

The created category.

Schemas
string

The request was rejected: a required field is missing from the body, or a value in it is not acceptable.

Schemas
{
  "code": 1,
  "err": "string"
}

Authentication failed or no API key was supplied.

Schemas
{
  "code": 1,
  "err": "string"
}

The account’s billing is past due and writes are locked. Reads keep working; editing resumes once billing is settled.

Schemas
{
  "code": 1,
  "err": "string"
}

The key lacks write permission, or the account’s plan does not include API access.

Schemas
{
  "code": 1,
  "err": "string"
}

Rate limited. Wait the number of seconds in Retry-After before trying again. X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset say which allowance was spent and when it refills.

Schemas
Generated

Authentication

    • ApiKeyBearer http bearer

      An API key sent as Authorization: Bearer <key>. A key holds scopes, the same ones OAuth uses, and an operation needs the scope listed for it under OAuth2. A key may also expire, or be revoked or rotated in Settings > API, after which it is refused with a 401.

    • OAuth2 oauth2

      An OAuth 2.0 access token for an app acting on behalf of a HelpDocs user, sent as Authorization: Bearer <token>. The authorization code flow requires PKCE (S256). Each operation names the one scope it needs.

      Scopes write:categories

Request body Required

The category to create.

application/json CreateCategoryRequest
  • parent_category_id string
  • is_featured boolean
  • icon string
  • enforce_permissions boolean
  • permission_groups array of string Nullable

    Null is the same as leaving the field out.

  • language_code string
  • title string
  • description string
  • slug string
  • multilingual array of CreateCategoryVersion Nullable

    Null is the same as leaving the field out.

{
  "parent_category_id": "string",
  "is_featured": true,
  "icon": "string",
  "enforce_permissions": true,
  "permission_groups": [
    "string"
  ],
  "language_code": "string",
  "title": "string",
  "description": "string",
  "slug": "string",
  "multilingual": [
    {
      "language_code": "string",
      "title": "string",
      "description": "string",
      "slug": "string"
    }
  ]
}

Generated from the schema

Responses

200

The created category.

application/json CategoryResponse
400

The request was rejected: a required field is missing from the body, or a value in it is not acceptable.

text/plain

The failure, as a human-readable message.

  • string

    The failure, as a human-readable message.

401

Authentication failed or no API key was supplied.

application/json Error

An error response.

  • code integer Required

    The HTTP status code.

  • err string Required

    A human-readable description of the failure.

402

The account’s billing is past due and writes are locked. Reads keep working; editing resumes once billing is settled.

application/json Error

An error response.

  • code integer Required

    The HTTP status code.

  • err string Required

    A human-readable description of the failure.

403

The key lacks write permission, or the account’s plan does not include API access.

application/json Error

An error response.

  • code integer Required

    The HTTP status code.

  • err string Required

    A human-readable description of the failure.

429

Rate limited. Wait the number of seconds in Retry-After before trying again. X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset say which allowance was spent and when it refills.

headers

  • Retry-After integer
  • X-RateLimit-Limit integer
  • X-RateLimit-Remaining integer
  • X-RateLimit-Reset integer
application/json Error

An error response.

  • code integer Required

    The HTTP status code.

  • err string Required

    A human-readable description of the failure.

All endpoints