Propose a set of new Help Center articles
curl --request POST \
--url https://api.protodesk.io/v1/authoring/article-sets \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"name": "<string>",
"articles": [
{
"slug": "<string>",
"locale": "<string>",
"tags": [
"<string>"
],
"featured": true,
"content": {
"title": "<string>",
"excerpt": "<string>",
"bodyMarkdown": "<string>"
},
"collectionId": "<string>",
"reviewNote": "<string>"
}
]
}
'import requests
url = "https://api.protodesk.io/v1/authoring/article-sets"
payload = {
"name": "<string>",
"articles": [
{
"slug": "<string>",
"locale": "<string>",
"tags": ["<string>"],
"featured": True,
"content": {
"title": "<string>",
"excerpt": "<string>",
"bodyMarkdown": "<string>"
},
"collectionId": "<string>",
"reviewNote": "<string>"
}
]
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
articles: [
{
slug: '<string>',
locale: '<string>',
tags: ['<string>'],
featured: true,
content: {title: '<string>', excerpt: '<string>', bodyMarkdown: '<string>'},
collectionId: '<string>',
reviewNote: '<string>'
}
]
})
};
fetch('https://api.protodesk.io/v1/authoring/article-sets', 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://api.protodesk.io/v1/authoring/article-sets",
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' => '<string>',
'articles' => [
[
'slug' => '<string>',
'locale' => '<string>',
'tags' => [
'<string>'
],
'featured' => true,
'content' => [
'title' => '<string>',
'excerpt' => '<string>',
'bodyMarkdown' => '<string>'
],
'collectionId' => '<string>',
'reviewNote' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$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://api.protodesk.io/v1/authoring/article-sets"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"articles\": [\n {\n \"slug\": \"<string>\",\n \"locale\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"featured\": true,\n \"content\": {\n \"title\": \"<string>\",\n \"excerpt\": \"<string>\",\n \"bodyMarkdown\": \"<string>\"\n },\n \"collectionId\": \"<string>\",\n \"reviewNote\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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://api.protodesk.io/v1/authoring/article-sets")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"articles\": [\n {\n \"slug\": \"<string>\",\n \"locale\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"featured\": true,\n \"content\": {\n \"title\": \"<string>\",\n \"excerpt\": \"<string>\",\n \"bodyMarkdown\": \"<string>\"\n },\n \"collectionId\": \"<string>\",\n \"reviewNote\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.protodesk.io/v1/authoring/article-sets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"articles\": [\n {\n \"slug\": \"<string>\",\n \"locale\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"featured\": true,\n \"content\": {\n \"title\": \"<string>\",\n \"excerpt\": \"<string>\",\n \"bodyMarkdown\": \"<string>\"\n },\n \"collectionId\": \"<string>\",\n \"reviewNote\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"items": [
{
"kind": "update",
"articleSetId": "<string>",
"articleSetName": "<string>",
"newArticle": {
"slug": "<string>",
"collectionId": "<string>",
"tags": [
"<string>"
],
"featured": true,
"reviewNote": "<string>"
},
"id": "<string>",
"articleId": "<string>",
"status": "pending",
"baseRevision": 123,
"currentRevision": 123,
"content": {
"title": "<string>",
"excerpt": "<string>",
"bodyMarkdown": "<string>"
},
"reviewUrl": "<string>",
"publicationChanged": true,
"locale": "<string>",
"title": "<string>"
}
],
"reviewUrl": "<string>",
"publicationChanged": false
}{
"error": {
"code": "route.not_found",
"message": "Not found",
"requestId": "req_x6q5vl75f5d53m7oet2k4r5w6a"
}
}Help authoring
Propose a set of new Help Center articles
Requires help:read and help:drafts:write. Atomically stores 1–20 immutable candidates, not canonical articles. Human approval adds unpublished drafts. Maximum serialized request 64 KiB. Retry only identical payload and Idempotency-Key. Duplicate locale/slug candidates or canonical URLs conflict; nothing is silently renamed. No repository access or publishing.
POST
/
authoring
/
article-sets
Propose a set of new Help Center articles
curl --request POST \
--url https://api.protodesk.io/v1/authoring/article-sets \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"name": "<string>",
"articles": [
{
"slug": "<string>",
"locale": "<string>",
"tags": [
"<string>"
],
"featured": true,
"content": {
"title": "<string>",
"excerpt": "<string>",
"bodyMarkdown": "<string>"
},
"collectionId": "<string>",
"reviewNote": "<string>"
}
]
}
'import requests
url = "https://api.protodesk.io/v1/authoring/article-sets"
payload = {
"name": "<string>",
"articles": [
{
"slug": "<string>",
"locale": "<string>",
"tags": ["<string>"],
"featured": True,
"content": {
"title": "<string>",
"excerpt": "<string>",
"bodyMarkdown": "<string>"
},
"collectionId": "<string>",
"reviewNote": "<string>"
}
]
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
articles: [
{
slug: '<string>',
locale: '<string>',
tags: ['<string>'],
featured: true,
content: {title: '<string>', excerpt: '<string>', bodyMarkdown: '<string>'},
collectionId: '<string>',
reviewNote: '<string>'
}
]
})
};
fetch('https://api.protodesk.io/v1/authoring/article-sets', 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://api.protodesk.io/v1/authoring/article-sets",
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' => '<string>',
'articles' => [
[
'slug' => '<string>',
'locale' => '<string>',
'tags' => [
'<string>'
],
'featured' => true,
'content' => [
'title' => '<string>',
'excerpt' => '<string>',
'bodyMarkdown' => '<string>'
],
'collectionId' => '<string>',
'reviewNote' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$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://api.protodesk.io/v1/authoring/article-sets"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"articles\": [\n {\n \"slug\": \"<string>\",\n \"locale\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"featured\": true,\n \"content\": {\n \"title\": \"<string>\",\n \"excerpt\": \"<string>\",\n \"bodyMarkdown\": \"<string>\"\n },\n \"collectionId\": \"<string>\",\n \"reviewNote\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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://api.protodesk.io/v1/authoring/article-sets")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"articles\": [\n {\n \"slug\": \"<string>\",\n \"locale\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"featured\": true,\n \"content\": {\n \"title\": \"<string>\",\n \"excerpt\": \"<string>\",\n \"bodyMarkdown\": \"<string>\"\n },\n \"collectionId\": \"<string>\",\n \"reviewNote\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.protodesk.io/v1/authoring/article-sets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"articles\": [\n {\n \"slug\": \"<string>\",\n \"locale\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"featured\": true,\n \"content\": {\n \"title\": \"<string>\",\n \"excerpt\": \"<string>\",\n \"bodyMarkdown\": \"<string>\"\n },\n \"collectionId\": \"<string>\",\n \"reviewNote\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"items": [
{
"kind": "update",
"articleSetId": "<string>",
"articleSetName": "<string>",
"newArticle": {
"slug": "<string>",
"collectionId": "<string>",
"tags": [
"<string>"
],
"featured": true,
"reviewNote": "<string>"
},
"id": "<string>",
"articleId": "<string>",
"status": "pending",
"baseRevision": 123,
"currentRevision": 123,
"content": {
"title": "<string>",
"excerpt": "<string>",
"bodyMarkdown": "<string>"
},
"reviewUrl": "<string>",
"publicationChanged": true,
"locale": "<string>",
"title": "<string>"
}
],
"reviewUrl": "<string>",
"publicationChanged": false
}{
"error": {
"code": "route.not_found",
"message": "Not found",
"requestId": "req_x6q5vl75f5d53m7oet2k4r5w6a"
}
}Authorizations
Use a workspace API key in the Authorization header. Keys use pk_live_<key_id> for production and pk_test<key_id>_ for test mode.
Headers
Required string length:
8 - 128Pattern:
^[!-~]{8,128}$Body
application/json
