Update a help center article
curl --request PUT \
--url http://localhost:8080/hc/{helpCenterId}/articles/{entityId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"content_html": "<string>",
"meta_title": "<string>",
"meta_description": "<string>",
"language_code": "<string>"
}
'import requests
url = "http://localhost:8080/hc/{helpCenterId}/articles/{entityId}"
payload = {
"title": "<string>",
"content_html": "<string>",
"meta_title": "<string>",
"meta_description": "<string>",
"language_code": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
content_html: '<string>',
meta_title: '<string>',
meta_description: '<string>',
language_code: '<string>'
})
};
fetch('http://localhost:8080/hc/{helpCenterId}/articles/{entityId}', 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/{helpCenterId}/articles/{entityId}",
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([
'title' => '<string>',
'content_html' => '<string>',
'meta_title' => '<string>',
'meta_description' => '<string>',
'language_code' => '<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/{helpCenterId}/articles/{entityId}"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"content_html\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\",\n \"language_code\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("http://localhost:8080/hc/{helpCenterId}/articles/{entityId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"content_html\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\",\n \"language_code\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/hc/{helpCenterId}/articles/{entityId}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"content_html\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\",\n \"language_code\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"sourceVersion": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version_number": 0,
"content_html": "<string>",
"meta_title": "<string>",
"meta_description": "<string>",
"generated_from_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"is_active": true
},
"locale": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"help_center_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"language_code": "<string>",
"title": "<string>",
"slug": "<string>",
"content_html": "<string>",
"is_manual": true,
"translated_from_locale_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"is_published": true,
"published_at": "2023-11-07T05:31:56Z"
},
"primaryLocale": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"help_center_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"language_code": "<string>",
"title": "<string>",
"slug": "<string>",
"content_html": "<string>",
"is_manual": true,
"translated_from_locale_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"is_published": true,
"published_at": "2023-11-07T05:31:56Z"
}
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Articles
Update a help center article
Create a new draft version of a help center article with new title or content. Publish it afterwards to replace the live version.
PUT
/
hc
/
{helpCenterId}
/
articles
/
{entityId}
Update a help center article
curl --request PUT \
--url http://localhost:8080/hc/{helpCenterId}/articles/{entityId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"content_html": "<string>",
"meta_title": "<string>",
"meta_description": "<string>",
"language_code": "<string>"
}
'import requests
url = "http://localhost:8080/hc/{helpCenterId}/articles/{entityId}"
payload = {
"title": "<string>",
"content_html": "<string>",
"meta_title": "<string>",
"meta_description": "<string>",
"language_code": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
content_html: '<string>',
meta_title: '<string>',
meta_description: '<string>',
language_code: '<string>'
})
};
fetch('http://localhost:8080/hc/{helpCenterId}/articles/{entityId}', 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/{helpCenterId}/articles/{entityId}",
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([
'title' => '<string>',
'content_html' => '<string>',
'meta_title' => '<string>',
'meta_description' => '<string>',
'language_code' => '<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/{helpCenterId}/articles/{entityId}"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"content_html\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\",\n \"language_code\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("http://localhost:8080/hc/{helpCenterId}/articles/{entityId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"content_html\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\",\n \"language_code\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/hc/{helpCenterId}/articles/{entityId}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"content_html\": \"<string>\",\n \"meta_title\": \"<string>\",\n \"meta_description\": \"<string>\",\n \"language_code\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"sourceVersion": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version_number": 0,
"content_html": "<string>",
"meta_title": "<string>",
"meta_description": "<string>",
"generated_from_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"is_active": true
},
"locale": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"help_center_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"language_code": "<string>",
"title": "<string>",
"slug": "<string>",
"content_html": "<string>",
"is_manual": true,
"translated_from_locale_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"is_published": true,
"published_at": "2023-11-07T05:31:56Z"
},
"primaryLocale": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"help_center_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"language_code": "<string>",
"title": "<string>",
"slug": "<string>",
"content_html": "<string>",
"is_manual": true,
"translated_from_locale_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"is_published": true,
"published_at": "2023-11-07T05:31:56Z"
}
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}The body is an HTML fragment in
content_html; omit it to change only the title or search metadata and keep the existing body. Without language_code the update applies to the article’s source language. Publishing is a separate call.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
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)$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
Minimum string length:
1Article body as an HTML fragment. Embed a video with <div data-embed="youtube" data-embed-id="VIDEO_ID"></div>, where data-embed is youtube, vimeo, loom or wistia; iframes are removed.
Was this page helpful?