Update a help article (operator)
curl --request PUT \
--url https://api.hq.zone/v1/help/articles/{slug} \
--header 'Content-Type: application/json' \
--cookie hq-session= \
--data '
{
"body": "<string>",
"category": "<string>",
"title": "<string>",
"ord": 123,
"summary": "<string>"
}
'import requests
url = "https://api.hq.zone/v1/help/articles/{slug}"
payload = {
"body": "<string>",
"category": "<string>",
"title": "<string>",
"ord": 123,
"summary": "<string>"
}
headers = {
"cookie": "hq-session=",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {cookie: 'hq-session=', 'Content-Type': 'application/json'},
body: JSON.stringify({
body: JSON.stringify('<string>'),
category: '<string>',
title: '<string>',
ord: 123,
summary: '<string>'
})
};
fetch('https://api.hq.zone/v1/help/articles/{slug}', 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.hq.zone/v1/help/articles/{slug}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'body' => '<string>',
'category' => '<string>',
'title' => '<string>',
'ord' => 123,
'summary' => '<string>'
]),
CURLOPT_COOKIE => "hq-session=",
CURLOPT_HTTPHEADER => [
"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://api.hq.zone/v1/help/articles/{slug}"
payload := strings.NewReader("{\n \"body\": \"<string>\",\n \"category\": \"<string>\",\n \"title\": \"<string>\",\n \"ord\": 123,\n \"summary\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("cookie", "hq-session=")
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.put("https://api.hq.zone/v1/help/articles/{slug}")
.header("cookie", "hq-session=")
.header("Content-Type", "application/json")
.body("{\n \"body\": \"<string>\",\n \"category\": \"<string>\",\n \"title\": \"<string>\",\n \"ord\": 123,\n \"summary\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hq.zone/v1/help/articles/{slug}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["cookie"] = 'hq-session='
request["Content-Type"] = 'application/json'
request.body = "{\n \"body\": \"<string>\",\n \"category\": \"<string>\",\n \"title\": \"<string>\",\n \"ord\": 123,\n \"summary\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"body": "<string>",
"category": "<string>",
"ord": 123,
"slug": "<string>",
"summary": "<string>",
"title": "<string>"
}Help
Update a help article (operator)
PUT /v1/help/articles/{slug} - replace an article’s fields. Operator-only.
Re-chunked + re-embedded + re-indexed before returning.
PUT
/
v1
/
help
/
articles
/
{slug}
Update a help article (operator)
curl --request PUT \
--url https://api.hq.zone/v1/help/articles/{slug} \
--header 'Content-Type: application/json' \
--cookie hq-session= \
--data '
{
"body": "<string>",
"category": "<string>",
"title": "<string>",
"ord": 123,
"summary": "<string>"
}
'import requests
url = "https://api.hq.zone/v1/help/articles/{slug}"
payload = {
"body": "<string>",
"category": "<string>",
"title": "<string>",
"ord": 123,
"summary": "<string>"
}
headers = {
"cookie": "hq-session=",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {cookie: 'hq-session=', 'Content-Type': 'application/json'},
body: JSON.stringify({
body: JSON.stringify('<string>'),
category: '<string>',
title: '<string>',
ord: 123,
summary: '<string>'
})
};
fetch('https://api.hq.zone/v1/help/articles/{slug}', 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.hq.zone/v1/help/articles/{slug}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'body' => '<string>',
'category' => '<string>',
'title' => '<string>',
'ord' => 123,
'summary' => '<string>'
]),
CURLOPT_COOKIE => "hq-session=",
CURLOPT_HTTPHEADER => [
"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://api.hq.zone/v1/help/articles/{slug}"
payload := strings.NewReader("{\n \"body\": \"<string>\",\n \"category\": \"<string>\",\n \"title\": \"<string>\",\n \"ord\": 123,\n \"summary\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("cookie", "hq-session=")
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.put("https://api.hq.zone/v1/help/articles/{slug}")
.header("cookie", "hq-session=")
.header("Content-Type", "application/json")
.body("{\n \"body\": \"<string>\",\n \"category\": \"<string>\",\n \"title\": \"<string>\",\n \"ord\": 123,\n \"summary\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hq.zone/v1/help/articles/{slug}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["cookie"] = 'hq-session='
request["Content-Type"] = 'application/json'
request.body = "{\n \"body\": \"<string>\",\n \"category\": \"<string>\",\n \"title\": \"<string>\",\n \"ord\": 123,\n \"summary\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"body": "<string>",
"category": "<string>",
"ord": 123,
"slug": "<string>",
"summary": "<string>",
"title": "<string>"
}Authorizations
Browser session cookie set by sign-in. Web SPA only; not for PAT/OAuth integrators.
Path Parameters
Article slug
Body
application/json
⌘I