Create category
curl --request POST \
--url https://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/categories \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"categoryTitle": "<string>",
"categoryDescription": "<string>",
"categoryIconUrl": "<string>",
"categoryOrder": 5000,
"categorySlug": "<string>"
}
'import requests
url = "https://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/categories"
payload = {
"categoryTitle": "<string>",
"categoryDescription": "<string>",
"categoryIconUrl": "<string>",
"categoryOrder": 5000,
"categorySlug": "<string>"
}
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({
categoryTitle: '<string>',
categoryDescription: '<string>',
categoryIconUrl: '<string>',
categoryOrder: 5000,
categorySlug: '<string>'
})
};
fetch('https://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/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://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/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([
'categoryTitle' => '<string>',
'categoryDescription' => '<string>',
'categoryIconUrl' => '<string>',
'categoryOrder' => 5000,
'categorySlug' => '<string>'
]),
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://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/categories"
payload := strings.NewReader("{\n \"categoryTitle\": \"<string>\",\n \"categoryDescription\": \"<string>\",\n \"categoryIconUrl\": \"<string>\",\n \"categoryOrder\": 5000,\n \"categorySlug\": \"<string>\"\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://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/categories")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"categoryTitle\": \"<string>\",\n \"categoryDescription\": \"<string>\",\n \"categoryIconUrl\": \"<string>\",\n \"categoryOrder\": 5000,\n \"categorySlug\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/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 \"categoryTitle\": \"<string>\",\n \"categoryDescription\": \"<string>\",\n \"categoryIconUrl\": \"<string>\",\n \"categoryOrder\": 5000,\n \"categorySlug\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"category": {
"categoryDescription": "<string>",
"categoryID": "<string>",
"categoryIconUrl": "<string>",
"categoryOrder": 123,
"categorySlug": "<string>",
"categoryStatus": "draft",
"categoryTitle": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"helpdeskID": "<string>",
"tenantID": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "<string>"
}
}{
"errors": [
{
"error": "MissingTenantIDError",
"error_code": 1001,
"message": "tenantID is required.",
"statusCode": 400
}
]
}{
"errors": [
{
"error": "HelpdeskNotFoundError",
"error_code": 1107,
"message": "No help center answers on this address.",
"statusCode": 404
}
]
}{
"errors": [
{
"error": "SlugAlreadyInUseError",
"error_code": 1110,
"message": "This slug is already in use in this help center.",
"statusCode": 409
}
]
}{
"errors": [
{
"error": "TenantNotConnectedError",
"error_code": 1000,
"message": "This tenant is not connected to the plugin.",
"statusCode": 422
}
]
}{
"errors": [
{
"error": "UnknownError",
"error_code": 5999,
"message": "For some unknown reason your request has not succeeded.",
"statusCode": 500
}
]
}Categories
Create category
Creates a category in the tenant’s help center. The slug is normalized
server-side and checked for collisions inside this help center only —
two tenants may both own getting-started.
POST
/
v1
/
tenants
/
{tenantID}
/
categories
Create category
curl --request POST \
--url https://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/categories \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"categoryTitle": "<string>",
"categoryDescription": "<string>",
"categoryIconUrl": "<string>",
"categoryOrder": 5000,
"categorySlug": "<string>"
}
'import requests
url = "https://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/categories"
payload = {
"categoryTitle": "<string>",
"categoryDescription": "<string>",
"categoryIconUrl": "<string>",
"categoryOrder": 5000,
"categorySlug": "<string>"
}
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({
categoryTitle: '<string>',
categoryDescription: '<string>',
categoryIconUrl: '<string>',
categoryOrder: 5000,
categorySlug: '<string>'
})
};
fetch('https://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/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://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/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([
'categoryTitle' => '<string>',
'categoryDescription' => '<string>',
'categoryIconUrl' => '<string>',
'categoryOrder' => 5000,
'categorySlug' => '<string>'
]),
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://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/categories"
payload := strings.NewReader("{\n \"categoryTitle\": \"<string>\",\n \"categoryDescription\": \"<string>\",\n \"categoryIconUrl\": \"<string>\",\n \"categoryOrder\": 5000,\n \"categorySlug\": \"<string>\"\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://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/categories")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"categoryTitle\": \"<string>\",\n \"categoryDescription\": \"<string>\",\n \"categoryIconUrl\": \"<string>\",\n \"categoryOrder\": 5000,\n \"categorySlug\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/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 \"categoryTitle\": \"<string>\",\n \"categoryDescription\": \"<string>\",\n \"categoryIconUrl\": \"<string>\",\n \"categoryOrder\": 5000,\n \"categorySlug\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"category": {
"categoryDescription": "<string>",
"categoryID": "<string>",
"categoryIconUrl": "<string>",
"categoryOrder": 123,
"categorySlug": "<string>",
"categoryStatus": "draft",
"categoryTitle": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"helpdeskID": "<string>",
"tenantID": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "<string>"
}
}{
"errors": [
{
"error": "MissingTenantIDError",
"error_code": 1001,
"message": "tenantID is required.",
"statusCode": 400
}
]
}{
"errors": [
{
"error": "HelpdeskNotFoundError",
"error_code": 1107,
"message": "No help center answers on this address.",
"statusCode": 404
}
]
}{
"errors": [
{
"error": "SlugAlreadyInUseError",
"error_code": 1110,
"message": "This slug is already in use in this help center.",
"statusCode": 409
}
]
}{
"errors": [
{
"error": "TenantNotConnectedError",
"error_code": 1000,
"message": "This tenant is not connected to the plugin.",
"statusCode": 422
}
]
}{
"errors": [
{
"error": "UnknownError",
"error_code": 5999,
"message": "For some unknown reason your request has not succeeded.",
"statusCode": 500
}
]
}Authorizations
operatorAuthpluginConnectionAuthpluginAuth
Behalf of an Operator. The JWT issued by Talqui Core when an operator signs in. Send as Authorization: Bearer <jwt-token>.
Path Parameters
The tenant the help center belongs to.
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Body
application/json
Required string length:
1 - 200Maximum string length:
2000Required range:
0 <= x <= 10000Derived from the title when omitted.
Required string length:
1 - 160Defaults to draft — nothing goes public by accident.
Available options:
draft, published Response
Response for status 201.
Show child attributes
Show child attributes
⌘I