Add a new category

POST

api

accounts

{account_id}

portals

{id}

categories

Add a new category

curl --request POST \
  --url https://app.chatwoot.com/api/v1/accounts/{account_id}/portals/{id}/categories \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Category Name",
  "description": "Category description",
  "position": 1,
  "slug": "category-name",
  "locale": "en",
  "icon": "📚",
  "parent_category_id": 1,
  "associated_category_id": 2
}
'

import requests

url = "https://app.chatwoot.com/api/v1/accounts/{account_id}/portals/{id}/categories"

payload = {
    "name": "Category Name",
    "description": "Category description",
    "position": 1,
    "slug": "category-name",
    "locale": "en",
    "icon": "📚",
    "parent_category_id": 1,
    "associated_category_id": 2
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Category Name',
    description: 'Category description',
    position: 1,
    slug: 'category-name',
    locale: 'en',
    icon: '📚',
    parent_category_id: 1,
    associated_category_id: 2
  })
};

fetch('https://app.chatwoot.com/api/v1/accounts/{account_id}/portals/{id}/categories', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.chatwoot.com/api/v1/accounts/{account_id}/portals/{id}/categories",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Category Name',
    'description' => 'Category description',
    'position' => 1,
    'slug' => 'category-name',
    'locale' => 'en',
    'icon' => '📚',
    'parent_category_id' => 1,
    'associated_category_id' => 2
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://app.chatwoot.com/api/v1/accounts/{account_id}/portals/{id}/categories"

	payload := strings.NewReader("{\n  \"name\": \"Category Name\",\n  \"description\": \"Category description\",\n  \"position\": 1,\n  \"slug\": \"category-name\",\n  \"locale\": \"en\",\n  \"icon\": \"📚\",\n  \"parent_category_id\": 1,\n  \"associated_category_id\": 2\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.chatwoot.com/api/v1/accounts/{account_id}/portals/{id}/categories")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Category Name\",\n  \"description\": \"Category description\",\n  \"position\": 1,\n  \"slug\": \"category-name\",\n  \"locale\": \"en\",\n  \"icon\": \"📚\",\n  \"parent_category_id\": 1,\n  \"associated_category_id\": 2\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.chatwoot.com/api/v1/accounts/{account_id}/portals/{id}/categories")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Category Name\",\n  \"description\": \"Category description\",\n  \"position\": 1,\n  \"slug\": \"category-name\",\n  \"locale\": \"en\",\n  \"icon\": \"📚\",\n  \"parent_category_id\": 1,\n  \"associated_category_id\": 2\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "description": "<string>",
  "locale": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "position": 123,
  "portal_id": 123,
  "account_id": 123,
  "associated_category_id": 123,
  "parent_category_id": 123
}

{
  "description": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Authenticate with Authorization: Bearer <token> using a user API token from Profile Settings. Available in Chatwoot v4.19.0 and later.

Path Parameters

account_id

integer

required

The numeric ID of the account

string

required

The slug identifier of the portal

Body

application/json

name

string

The name of the category

Example:

"Category Name"

description

string

A description for the category

Example:

"Category description"

position

integer

Category position in the portal list to sort

Example:

1

slug

string

The category slug used in the URL

Example:

"category-name"

locale

string

The locale of the category

Example:

"en"

icon

string

The icon of the category as a string (emoji)

Example:

"📚"

parent_category_id

integer

To define parent category, e.g product documentation has multiple level features in sales category or in engineering category.

Example:

1

associated_category_id

integer

To associate similar categories to each other, e.g same category of product documentation in different languages

Example:

2

Response

Success

integer

description

string

The text content.

locale

string

name

string

slug

string

position

integer

portal_id

integer

account_id

integer

associated_category_id

integer

To associate similar categories to each other, e.g same category of product documentation in different languages

parent_category_id

integer

To define parent category, e.g product documentation has multiple level features in sales category or in engineering category.

Add a new category

curl --request POST \
  --url https://app.chatwoot.com/api/v1/accounts/{account_id}/portals/{id}/categories \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Category Name",
  "description": "Category description",
  "position": 1,
  "slug": "category-name",
  "locale": "en",
  "icon": "📚",
  "parent_category_id": 1,
  "associated_category_id": 2
}
'

import requests

url = "https://app.chatwoot.com/api/v1/accounts/{account_id}/portals/{id}/categories"

payload = {
    "name": "Category Name",
    "description": "Category description",
    "position": 1,
    "slug": "category-name",
    "locale": "en",
    "icon": "📚",
    "parent_category_id": 1,
    "associated_category_id": 2
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Category Name',
    description: 'Category description',
    position: 1,
    slug: 'category-name',
    locale: 'en',
    icon: '📚',
    parent_category_id: 1,
    associated_category_id: 2
  })
};

fetch('https://app.chatwoot.com/api/v1/accounts/{account_id}/portals/{id}/categories', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.chatwoot.com/api/v1/accounts/{account_id}/portals/{id}/categories",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Category Name',
    'description' => 'Category description',
    'position' => 1,
    'slug' => 'category-name',
    'locale' => 'en',
    'icon' => '📚',
    'parent_category_id' => 1,
    'associated_category_id' => 2
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://app.chatwoot.com/api/v1/accounts/{account_id}/portals/{id}/categories"

	payload := strings.NewReader("{\n  \"name\": \"Category Name\",\n  \"description\": \"Category description\",\n  \"position\": 1,\n  \"slug\": \"category-name\",\n  \"locale\": \"en\",\n  \"icon\": \"📚\",\n  \"parent_category_id\": 1,\n  \"associated_category_id\": 2\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.chatwoot.com/api/v1/accounts/{account_id}/portals/{id}/categories")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Category Name\",\n  \"description\": \"Category description\",\n  \"position\": 1,\n  \"slug\": \"category-name\",\n  \"locale\": \"en\",\n  \"icon\": \"📚\",\n  \"parent_category_id\": 1,\n  \"associated_category_id\": 2\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.chatwoot.com/api/v1/accounts/{account_id}/portals/{id}/categories")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Category Name\",\n  \"description\": \"Category description\",\n  \"position\": 1,\n  \"slug\": \"category-name\",\n  \"locale\": \"en\",\n  \"icon\": \"📚\",\n  \"parent_category_id\": 1,\n  \"associated_category_id\": 2\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "description": "<string>",
  "locale": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "position": 123,
  "portal_id": 123,
  "account_id": 123,
  "associated_category_id": 123,
  "parent_category_id": 123
}

{
  "description": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

Getting Started

Application APIs

Platform APIs

Client APIs

Other APIs

Authorizations

Path Parameters

Body

Response