Sync help center content
curl --request POST \
--url http://localhost:8080/hc/{id}/sync \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"categories": [
{
"name": "<string>",
"slug": "<string>",
"articles": [
{
"title": "<string>",
"slug": "<string>",
"content_markdown": "<string>",
"meta_title": "<string>",
"meta_description": "<string>"
}
],
"description": "<string>",
"icon": "<string>",
"categories": [
{
"name": "<string>",
"slug": "<string>",
"articles": [
{
"title": "<string>",
"slug": "<string>",
"content_markdown": "<string>",
"meta_title": "<string>",
"meta_description": "<string>"
}
],
"description": "<string>",
"icon": "<string>",
"categories": [
{
"name": "<string>",
"slug": "<string>",
"articles": [
{
"title": "<string>",
"slug": "<string>",
"content_markdown": "<string>",
"meta_title": "<string>",
"meta_description": "<string>"
}
],
"description": "<string>",
"icon": "<string>",
"categories": [
{
"name": "<string>",
"slug": "<string>",
"articles": [
{
"title": "<string>",
"slug": "<string>",
"content_markdown": "<string>",
"meta_title": "<string>",
"meta_description": "<string>"
}
],
"description": "<string>",
"icon": "<string>",
"categories": [
{
"name": "<string>",
"slug": "<string>",
"articles": [
{
"title": "<string>",
"slug": "<string>",
"content_markdown": "<string>",
"meta_title": "<string>",
"meta_description": "<string>"
}
],
"description": "<string>",
"icon": "<string>",
"categories": [
{
"name": "<string>",
"slug": "<string>",
"articles": [
{
"title": "<string>",
"slug": "<string>",
"content_markdown": "<string>",
"meta_title": "<string>",
"meta_description": "<string>"
}
],
"description": "<string>",
"icon": "<string>"
}
]
}
]
}
]
}
]
}
]
}
],
"openapi_spec": "<string>"
}
'import requests
url = "http://localhost:8080/hc/{id}/sync"
payload = {
"categories": [
{
"name": "<string>",
"slug": "<string>",
"articles": [
{
"title": "<string>",
"slug": "<string>",
"content_markdown": "<string>",
"meta_title": "<string>",
"meta_description": "<string>"
}
],
"description": "<string>",
"icon": "<string>",
"categories": [
{
"name": "<string>",
"slug": "<string>",
"articles": [
{
"title": "<string>",
"slug": "<string>",
"content_markdown": "<string>",
"meta_title": "<string>",
"meta_description": "<string>"
}
],
"description": "<string>",
"icon": "<string>",
"categories": [
{
"name": "<string>",
"slug": "<string>",
"articles": [
{
"title": "<string>",
"slug": "<string>",
"content_markdown": "<string>",
"meta_title": "<string>",
"meta_description": "<string>"
}
],
"description": "<string>",
"icon": "<string>",
"categories": [
{
"name": "<string>",
"slug": "<string>",
"articles": [
{
"title": "<string>",
"slug": "<string>",
"content_markdown": "<string>",
"meta_title": "<string>",
"meta_description": "<string>"
}
],
"description": "<string>",
"icon": "<string>",
"categories": [
{
"name": "<string>",
"slug": "<string>",
"articles": [
{
"title": "<string>",
"slug": "<string>",
"content_markdown": "<string>",
"meta_title": "<string>",
"meta_description": "<string>"
}
],
"description": "<string>",
"icon": "<string>",
"categories": [
{
"name": "<string>",
"slug": "<string>",
"articles": [
{
"title": "<string>",
"slug": "<string>",
"content_markdown": "<string>",
"meta_title": "<string>",
"meta_description": "<string>"
}
],
"description": "<string>",
"icon": "<string>"
}
]
}
]
}
]
}
]
}
]
}
],
"openapi_spec": "<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({
categories: [
{
name: '<string>',
slug: '<string>',
articles: [
{
title: '<string>',
slug: '<string>',
content_markdown: '<string>',
meta_title: '<string>',
meta_description: '<string>'
}
],
description: '<string>',
icon: '<string>',
categories: [
{
name: '<string>',
slug: '<string>',
articles: [
{
title: '<string>',
slug: '<string>',
content_markdown: '<string>',
meta_title: '<string>',
meta_description: '<string>'
}
],
description: '<string>',
icon: '<string>',
categories: [
{
name: '<string>',
slug: '<string>',
articles: [
{
title: '<string>',
slug: '<string>',
content_markdown: '<string>',
meta_title: '<string>',
meta_description: '<string>'
}
],
description: '<string>',
icon: '<string>',
categories: [
{
name: '<string>',
slug: '<string>',
articles: [
{
title: '<string>',
slug: '<string>',
content_markdown: '<string>',
meta_title: '<string>',
meta_description: '<string>'
}
],
description: '<string>',
icon: '<string>',
categories: [
{
name: '<string>',
slug: '<string>',
articles: [
{
title: '<string>',
slug: '<string>',
content_markdown: '<string>',
meta_title: '<string>',
meta_description: '<string>'
}
],
description: '<string>',
icon: '<string>',
categories: [
{
name: '<string>',
slug: '<string>',
articles: [
{
title: '<string>',
slug: '<string>',
content_markdown: '<string>',
meta_title: '<string>',
meta_description: '<string>'
}
],
description: '<string>',
icon: '<string>'
}
]
}
]
}
]
}
]
}
]
}
],
openapi_spec: '<string>'
})
};
fetch('http://localhost:8080/hc/{id}/sync', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/hc/{id}/sync",
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([
'categories' => [
[
'name' => '<string>',
'slug' => '<string>',
'articles' => [
[
'title' => '<string>',
'slug' => '<string>',
'content_markdown' => '<string>',
'meta_title' => '<string>',
'meta_description' => '<string>'
]
],
'description' => '<string>',
'icon' => '<string>',
'categories' => [
[
'name' => '<string>',
'slug' => '<string>',
'articles' => [
[
'title' => '<string>',
'slug' => '<string>',
'content_markdown' => '<string>',
'meta_title' => '<string>',
'meta_description' => '<string>'
]
],
'description' => '<string>',
'icon' => '<string>',
'categories' => [
[
'name' => '<string>',
'slug' => '<string>',
'articles' => [
[
'title' => '<string>',
'slug' => '<string>',
'content_markdown' => '<string>',
'meta_title' => '<string>',
'meta_description' => '<string>'
]
],
'description' => '<string>',
'icon' => '<string>',
'categories' => [
[
'name' => '<string>',
'slug' => '<string>',
'articles' => [
[
'title' => '<string>',
'slug' => '<string>',
'content_markdown' => '<string>',
'meta_title' => '<string>',
'meta_description' => '<string>'
]
],
'description' => '<string>',
'icon' => '<string>',
'categories' => [
[
'name' => '<string>',
'slug' => '<string>',
'articles' => [
[
'title' => '<string>',
'slug' => '<string>',
'content_markdown' => '<string>',
'meta_title' => '<string>',
'meta_description' => '<string>'
]
],
'description' => '<string>',
'icon' => '<string>',
'categories' => [
[
'name' => '<string>',
'slug' => '<string>',
'articles' => [
[
'title' => '<string>',
'slug' => '<string>',
'content_markdown' => '<string>',
'meta_title' => '<string>',
'meta_description' => '<string>'
]
],
'description' => '<string>',
'icon' => '<string>'
]
]
]
]
]
]
]
]
]
]
]
],
'openapi_spec' => '<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 := "http://localhost:8080/hc/{id}/sync"
payload := strings.NewReader("{\n \"categories\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"articles\": [\n {\n \"title\": \"<string>\",\n \"slug\": \"<string>\",\n \"content_markdown\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"categories\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"articles\": [\n {\n \"title\": \"<string>\",\n \"slug\": \"<string>\",\n \"content_markdown\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"categories\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"articles\": [\n {\n \"title\": \"<string>\",\n \"slug\": \"<string>\",\n \"content_markdown\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"categories\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"articles\": [\n {\n \"title\": \"<string>\",\n \"slug\": \"<string>\",\n \"content_markdown\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"categories\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"articles\": [\n {\n \"title\": \"<string>\",\n \"slug\": \"<string>\",\n \"content_markdown\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"categories\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"articles\": [\n {\n \"title\": \"<string>\",\n \"slug\": \"<string>\",\n \"content_markdown\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"icon\": \"<string>\"\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n }\n ],\n \"openapi_spec\": \"<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("http://localhost:8080/hc/{id}/sync")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"categories\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"articles\": [\n {\n \"title\": \"<string>\",\n \"slug\": \"<string>\",\n \"content_markdown\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"categories\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"articles\": [\n {\n \"title\": \"<string>\",\n \"slug\": \"<string>\",\n \"content_markdown\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"categories\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"articles\": [\n {\n \"title\": \"<string>\",\n \"slug\": \"<string>\",\n \"content_markdown\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"categories\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"articles\": [\n {\n \"title\": \"<string>\",\n \"slug\": \"<string>\",\n \"content_markdown\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"categories\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"articles\": [\n {\n \"title\": \"<string>\",\n \"slug\": \"<string>\",\n \"content_markdown\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"categories\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"articles\": [\n {\n \"title\": \"<string>\",\n \"slug\": \"<string>\",\n \"content_markdown\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"icon\": \"<string>\"\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n }\n ],\n \"openapi_spec\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/hc/{id}/sync")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"categories\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"articles\": [\n {\n \"title\": \"<string>\",\n \"slug\": \"<string>\",\n \"content_markdown\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"categories\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"articles\": [\n {\n \"title\": \"<string>\",\n \"slug\": \"<string>\",\n \"content_markdown\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"categories\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"articles\": [\n {\n \"title\": \"<string>\",\n \"slug\": \"<string>\",\n \"content_markdown\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"categories\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"articles\": [\n {\n \"title\": \"<string>\",\n \"slug\": \"<string>\",\n \"content_markdown\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"categories\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"articles\": [\n {\n \"title\": \"<string>\",\n \"slug\": \"<string>\",\n \"content_markdown\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"categories\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"articles\": [\n {\n \"title\": \"<string>\",\n \"slug\": \"<string>\",\n \"content_markdown\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"icon\": \"<string>\"\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n }\n ],\n \"openapi_spec\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"changes": {
"categories": {
"added": 123,
"modified": 123,
"removed": 123
},
"articles": {
"added": 123,
"modified": 123,
"removed": 123
}
}
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Help Center
Sync help center content
Replace the whole help center content tree in one call, deleting anything you omit. Use when your articles live in git or a CMS and you push every change.
POST
/
hc
/
{id}
/
sync
Sync help center content
curl --request POST \
--url http://localhost:8080/hc/{id}/sync \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"categories": [
{
"name": "<string>",
"slug": "<string>",
"articles": [
{
"title": "<string>",
"slug": "<string>",
"content_markdown": "<string>",
"meta_title": "<string>",
"meta_description": "<string>"
}
],
"description": "<string>",
"icon": "<string>",
"categories": [
{
"name": "<string>",
"slug": "<string>",
"articles": [
{
"title": "<string>",
"slug": "<string>",
"content_markdown": "<string>",
"meta_title": "<string>",
"meta_description": "<string>"
}
],
"description": "<string>",
"icon": "<string>",
"categories": [
{
"name": "<string>",
"slug": "<string>",
"articles": [
{
"title": "<string>",
"slug": "<string>",
"content_markdown": "<string>",
"meta_title": "<string>",
"meta_description": "<string>"
}
],
"description": "<string>",
"icon": "<string>",
"categories": [
{
"name": "<string>",
"slug": "<string>",
"articles": [
{
"title": "<string>",
"slug": "<string>",
"content_markdown": "<string>",
"meta_title": "<string>",
"meta_description": "<string>"
}
],
"description": "<string>",
"icon": "<string>",
"categories": [
{
"name": "<string>",
"slug": "<string>",
"articles": [
{
"title": "<string>",
"slug": "<string>",
"content_markdown": "<string>",
"meta_title": "<string>",
"meta_description": "<string>"
}
],
"description": "<string>",
"icon": "<string>",
"categories": [
{
"name": "<string>",
"slug": "<string>",
"articles": [
{
"title": "<string>",
"slug": "<string>",
"content_markdown": "<string>",
"meta_title": "<string>",
"meta_description": "<string>"
}
],
"description": "<string>",
"icon": "<string>"
}
]
}
]
}
]
}
]
}
]
}
],
"openapi_spec": "<string>"
}
'import requests
url = "http://localhost:8080/hc/{id}/sync"
payload = {
"categories": [
{
"name": "<string>",
"slug": "<string>",
"articles": [
{
"title": "<string>",
"slug": "<string>",
"content_markdown": "<string>",
"meta_title": "<string>",
"meta_description": "<string>"
}
],
"description": "<string>",
"icon": "<string>",
"categories": [
{
"name": "<string>",
"slug": "<string>",
"articles": [
{
"title": "<string>",
"slug": "<string>",
"content_markdown": "<string>",
"meta_title": "<string>",
"meta_description": "<string>"
}
],
"description": "<string>",
"icon": "<string>",
"categories": [
{
"name": "<string>",
"slug": "<string>",
"articles": [
{
"title": "<string>",
"slug": "<string>",
"content_markdown": "<string>",
"meta_title": "<string>",
"meta_description": "<string>"
}
],
"description": "<string>",
"icon": "<string>",
"categories": [
{
"name": "<string>",
"slug": "<string>",
"articles": [
{
"title": "<string>",
"slug": "<string>",
"content_markdown": "<string>",
"meta_title": "<string>",
"meta_description": "<string>"
}
],
"description": "<string>",
"icon": "<string>",
"categories": [
{
"name": "<string>",
"slug": "<string>",
"articles": [
{
"title": "<string>",
"slug": "<string>",
"content_markdown": "<string>",
"meta_title": "<string>",
"meta_description": "<string>"
}
],
"description": "<string>",
"icon": "<string>",
"categories": [
{
"name": "<string>",
"slug": "<string>",
"articles": [
{
"title": "<string>",
"slug": "<string>",
"content_markdown": "<string>",
"meta_title": "<string>",
"meta_description": "<string>"
}
],
"description": "<string>",
"icon": "<string>"
}
]
}
]
}
]
}
]
}
]
}
],
"openapi_spec": "<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({
categories: [
{
name: '<string>',
slug: '<string>',
articles: [
{
title: '<string>',
slug: '<string>',
content_markdown: '<string>',
meta_title: '<string>',
meta_description: '<string>'
}
],
description: '<string>',
icon: '<string>',
categories: [
{
name: '<string>',
slug: '<string>',
articles: [
{
title: '<string>',
slug: '<string>',
content_markdown: '<string>',
meta_title: '<string>',
meta_description: '<string>'
}
],
description: '<string>',
icon: '<string>',
categories: [
{
name: '<string>',
slug: '<string>',
articles: [
{
title: '<string>',
slug: '<string>',
content_markdown: '<string>',
meta_title: '<string>',
meta_description: '<string>'
}
],
description: '<string>',
icon: '<string>',
categories: [
{
name: '<string>',
slug: '<string>',
articles: [
{
title: '<string>',
slug: '<string>',
content_markdown: '<string>',
meta_title: '<string>',
meta_description: '<string>'
}
],
description: '<string>',
icon: '<string>',
categories: [
{
name: '<string>',
slug: '<string>',
articles: [
{
title: '<string>',
slug: '<string>',
content_markdown: '<string>',
meta_title: '<string>',
meta_description: '<string>'
}
],
description: '<string>',
icon: '<string>',
categories: [
{
name: '<string>',
slug: '<string>',
articles: [
{
title: '<string>',
slug: '<string>',
content_markdown: '<string>',
meta_title: '<string>',
meta_description: '<string>'
}
],
description: '<string>',
icon: '<string>'
}
]
}
]
}
]
}
]
}
]
}
],
openapi_spec: '<string>'
})
};
fetch('http://localhost:8080/hc/{id}/sync', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/hc/{id}/sync",
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([
'categories' => [
[
'name' => '<string>',
'slug' => '<string>',
'articles' => [
[
'title' => '<string>',
'slug' => '<string>',
'content_markdown' => '<string>',
'meta_title' => '<string>',
'meta_description' => '<string>'
]
],
'description' => '<string>',
'icon' => '<string>',
'categories' => [
[
'name' => '<string>',
'slug' => '<string>',
'articles' => [
[
'title' => '<string>',
'slug' => '<string>',
'content_markdown' => '<string>',
'meta_title' => '<string>',
'meta_description' => '<string>'
]
],
'description' => '<string>',
'icon' => '<string>',
'categories' => [
[
'name' => '<string>',
'slug' => '<string>',
'articles' => [
[
'title' => '<string>',
'slug' => '<string>',
'content_markdown' => '<string>',
'meta_title' => '<string>',
'meta_description' => '<string>'
]
],
'description' => '<string>',
'icon' => '<string>',
'categories' => [
[
'name' => '<string>',
'slug' => '<string>',
'articles' => [
[
'title' => '<string>',
'slug' => '<string>',
'content_markdown' => '<string>',
'meta_title' => '<string>',
'meta_description' => '<string>'
]
],
'description' => '<string>',
'icon' => '<string>',
'categories' => [
[
'name' => '<string>',
'slug' => '<string>',
'articles' => [
[
'title' => '<string>',
'slug' => '<string>',
'content_markdown' => '<string>',
'meta_title' => '<string>',
'meta_description' => '<string>'
]
],
'description' => '<string>',
'icon' => '<string>',
'categories' => [
[
'name' => '<string>',
'slug' => '<string>',
'articles' => [
[
'title' => '<string>',
'slug' => '<string>',
'content_markdown' => '<string>',
'meta_title' => '<string>',
'meta_description' => '<string>'
]
],
'description' => '<string>',
'icon' => '<string>'
]
]
]
]
]
]
]
]
]
]
]
],
'openapi_spec' => '<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 := "http://localhost:8080/hc/{id}/sync"
payload := strings.NewReader("{\n \"categories\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"articles\": [\n {\n \"title\": \"<string>\",\n \"slug\": \"<string>\",\n \"content_markdown\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"categories\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"articles\": [\n {\n \"title\": \"<string>\",\n \"slug\": \"<string>\",\n \"content_markdown\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"categories\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"articles\": [\n {\n \"title\": \"<string>\",\n \"slug\": \"<string>\",\n \"content_markdown\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"categories\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"articles\": [\n {\n \"title\": \"<string>\",\n \"slug\": \"<string>\",\n \"content_markdown\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"categories\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"articles\": [\n {\n \"title\": \"<string>\",\n \"slug\": \"<string>\",\n \"content_markdown\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"categories\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"articles\": [\n {\n \"title\": \"<string>\",\n \"slug\": \"<string>\",\n \"content_markdown\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"icon\": \"<string>\"\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n }\n ],\n \"openapi_spec\": \"<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("http://localhost:8080/hc/{id}/sync")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"categories\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"articles\": [\n {\n \"title\": \"<string>\",\n \"slug\": \"<string>\",\n \"content_markdown\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"categories\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"articles\": [\n {\n \"title\": \"<string>\",\n \"slug\": \"<string>\",\n \"content_markdown\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"categories\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"articles\": [\n {\n \"title\": \"<string>\",\n \"slug\": \"<string>\",\n \"content_markdown\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"categories\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"articles\": [\n {\n \"title\": \"<string>\",\n \"slug\": \"<string>\",\n \"content_markdown\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"categories\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"articles\": [\n {\n \"title\": \"<string>\",\n \"slug\": \"<string>\",\n \"content_markdown\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"categories\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"articles\": [\n {\n \"title\": \"<string>\",\n \"slug\": \"<string>\",\n \"content_markdown\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"icon\": \"<string>\"\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n }\n ],\n \"openapi_spec\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/hc/{id}/sync")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"categories\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"articles\": [\n {\n \"title\": \"<string>\",\n \"slug\": \"<string>\",\n \"content_markdown\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"categories\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"articles\": [\n {\n \"title\": \"<string>\",\n \"slug\": \"<string>\",\n \"content_markdown\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"categories\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"articles\": [\n {\n \"title\": \"<string>\",\n \"slug\": \"<string>\",\n \"content_markdown\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"categories\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"articles\": [\n {\n \"title\": \"<string>\",\n \"slug\": \"<string>\",\n \"content_markdown\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"categories\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"articles\": [\n {\n \"title\": \"<string>\",\n \"slug\": \"<string>\",\n \"content_markdown\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"categories\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"articles\": [\n {\n \"title\": \"<string>\",\n \"slug\": \"<string>\",\n \"content_markdown\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"icon\": \"<string>\"\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n }\n ],\n \"openapi_spec\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"changes": {
"categories": {
"added": 123,
"modified": 123,
"removed": 123
},
"articles": {
"added": 123,
"modified": 123,
"removed": 123
}
}
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}This is a full replace, not an upsert. Every category or article that exists in the help center but is missing from the tree you send is permanently deleted, together with its version history and AI knowledge. There is no dry run, confirmation, or rollback. Always send the complete intended tree; use Export content to fetch the current one first.
What is atomic
Structural changes (categories, articles, publish state, deletions) are applied in a single database transaction: either the whole tree is reconciled or nothing changes. Synced articles are published as part of that transaction. AI knowledge updates and translations run after the commit. If one of them fails, the structural change is kept and the failure is reported as an error event in the SSE stream. The plain JSON response only returns change counts, so sendAccept: text/event-stream when you need to know about these failures. Re-run the sync, or retranslate the affected article, to retry.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
Default Response
Show child attributes
Show child attributes
Was this page helpful?