Update an article
curl --request PUT \
--url https://api.gleap.io/v3/helpcenter/collections/{helpcenterCollectionId}/articles/{helpcenterArticleId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<unknown>",
"description": "<unknown>",
"content": "<unknown>",
"plainContent": "<unknown>",
"helpcenterCollection": "<string>",
"author": "<string>",
"project": "<string>",
"isDraft": true,
"docId": 123,
"expectedVersion": 123,
"lexorank": "<string>",
"upvotes": "<unknown>",
"targetAudience": "all",
"externalId": "<string>",
"baseAudienceFilter": "<unknown>",
"extendedAudienceFilter": "<unknown>",
"tags": [
"<string>"
],
"newCollectionId": "<string>"
}
'import requests
url = "https://api.gleap.io/v3/helpcenter/collections/{helpcenterCollectionId}/articles/{helpcenterArticleId}"
payload = {
"title": "<unknown>",
"description": "<unknown>",
"content": "<unknown>",
"plainContent": "<unknown>",
"helpcenterCollection": "<string>",
"author": "<string>",
"project": "<string>",
"isDraft": True,
"docId": 123,
"expectedVersion": 123,
"lexorank": "<string>",
"upvotes": "<unknown>",
"targetAudience": "all",
"externalId": "<string>",
"baseAudienceFilter": "<unknown>",
"extendedAudienceFilter": "<unknown>",
"tags": ["<string>"],
"newCollectionId": "<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: '<unknown>',
description: '<unknown>',
content: '<unknown>',
plainContent: '<unknown>',
helpcenterCollection: '<string>',
author: '<string>',
project: '<string>',
isDraft: true,
docId: 123,
expectedVersion: 123,
lexorank: '<string>',
upvotes: '<unknown>',
targetAudience: 'all',
externalId: '<string>',
baseAudienceFilter: '<unknown>',
extendedAudienceFilter: '<unknown>',
tags: ['<string>'],
newCollectionId: '<string>'
})
};
fetch('https://api.gleap.io/v3/helpcenter/collections/{helpcenterCollectionId}/articles/{helpcenterArticleId}', 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.gleap.io/v3/helpcenter/collections/{helpcenterCollectionId}/articles/{helpcenterArticleId}",
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' => '<unknown>',
'description' => '<unknown>',
'content' => '<unknown>',
'plainContent' => '<unknown>',
'helpcenterCollection' => '<string>',
'author' => '<string>',
'project' => '<string>',
'isDraft' => true,
'docId' => 123,
'expectedVersion' => 123,
'lexorank' => '<string>',
'upvotes' => '<unknown>',
'targetAudience' => 'all',
'externalId' => '<string>',
'baseAudienceFilter' => '<unknown>',
'extendedAudienceFilter' => '<unknown>',
'tags' => [
'<string>'
],
'newCollectionId' => '<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://api.gleap.io/v3/helpcenter/collections/{helpcenterCollectionId}/articles/{helpcenterArticleId}"
payload := strings.NewReader("{\n \"title\": \"<unknown>\",\n \"description\": \"<unknown>\",\n \"content\": \"<unknown>\",\n \"plainContent\": \"<unknown>\",\n \"helpcenterCollection\": \"<string>\",\n \"author\": \"<string>\",\n \"project\": \"<string>\",\n \"isDraft\": true,\n \"docId\": 123,\n \"expectedVersion\": 123,\n \"lexorank\": \"<string>\",\n \"upvotes\": \"<unknown>\",\n \"targetAudience\": \"all\",\n \"externalId\": \"<string>\",\n \"baseAudienceFilter\": \"<unknown>\",\n \"extendedAudienceFilter\": \"<unknown>\",\n \"tags\": [\n \"<string>\"\n ],\n \"newCollectionId\": \"<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("https://api.gleap.io/v3/helpcenter/collections/{helpcenterCollectionId}/articles/{helpcenterArticleId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<unknown>\",\n \"description\": \"<unknown>\",\n \"content\": \"<unknown>\",\n \"plainContent\": \"<unknown>\",\n \"helpcenterCollection\": \"<string>\",\n \"author\": \"<string>\",\n \"project\": \"<string>\",\n \"isDraft\": true,\n \"docId\": 123,\n \"expectedVersion\": 123,\n \"lexorank\": \"<string>\",\n \"upvotes\": \"<unknown>\",\n \"targetAudience\": \"all\",\n \"externalId\": \"<string>\",\n \"baseAudienceFilter\": \"<unknown>\",\n \"extendedAudienceFilter\": \"<unknown>\",\n \"tags\": [\n \"<string>\"\n ],\n \"newCollectionId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gleap.io/v3/helpcenter/collections/{helpcenterCollectionId}/articles/{helpcenterArticleId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<unknown>\",\n \"description\": \"<unknown>\",\n \"content\": \"<unknown>\",\n \"plainContent\": \"<unknown>\",\n \"helpcenterCollection\": \"<string>\",\n \"author\": \"<string>\",\n \"project\": \"<string>\",\n \"isDraft\": true,\n \"docId\": 123,\n \"expectedVersion\": 123,\n \"lexorank\": \"<string>\",\n \"upvotes\": \"<unknown>\",\n \"targetAudience\": \"all\",\n \"externalId\": \"<string>\",\n \"baseAudienceFilter\": \"<unknown>\",\n \"extendedAudienceFilter\": \"<unknown>\",\n \"tags\": [\n \"<string>\"\n ],\n \"newCollectionId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"updatedAt": "<string>",
"createdAt": "<string>",
"sourceUsage": 123,
"version": 123,
"isDraft": true,
"targetAudience": "<string>",
"tags": [
"<string>"
],
"extendedAudienceFilter": "<unknown>",
"baseAudienceFilter": "<unknown>",
"docId": 123,
"author": {
"isValid": {},
"createFromHexString": {},
"createFromTime": {},
"generate": {},
"cacheHexString": "<unknown>"
},
"helpcenterCollection": {
"isValid": {},
"createFromHexString": {},
"createFromTime": {},
"generate": {},
"cacheHexString": "<unknown>"
},
"upvotes": "<unknown>",
"plainContent": "<unknown>",
"lexorank": "<string>",
"project": {
"isValid": {},
"createFromHexString": {},
"createFromTime": {},
"generate": {},
"cacheHexString": "<unknown>"
},
"externalId": "<string>",
"content": "<unknown>",
"title": "<unknown>",
"description": "<unknown>"
}Help center articles
Update an article
PUT
/
helpcenter
/
collections
/
{helpcenterCollectionId}
/
articles
/
{helpcenterArticleId}
Update an article
curl --request PUT \
--url https://api.gleap.io/v3/helpcenter/collections/{helpcenterCollectionId}/articles/{helpcenterArticleId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<unknown>",
"description": "<unknown>",
"content": "<unknown>",
"plainContent": "<unknown>",
"helpcenterCollection": "<string>",
"author": "<string>",
"project": "<string>",
"isDraft": true,
"docId": 123,
"expectedVersion": 123,
"lexorank": "<string>",
"upvotes": "<unknown>",
"targetAudience": "all",
"externalId": "<string>",
"baseAudienceFilter": "<unknown>",
"extendedAudienceFilter": "<unknown>",
"tags": [
"<string>"
],
"newCollectionId": "<string>"
}
'import requests
url = "https://api.gleap.io/v3/helpcenter/collections/{helpcenterCollectionId}/articles/{helpcenterArticleId}"
payload = {
"title": "<unknown>",
"description": "<unknown>",
"content": "<unknown>",
"plainContent": "<unknown>",
"helpcenterCollection": "<string>",
"author": "<string>",
"project": "<string>",
"isDraft": True,
"docId": 123,
"expectedVersion": 123,
"lexorank": "<string>",
"upvotes": "<unknown>",
"targetAudience": "all",
"externalId": "<string>",
"baseAudienceFilter": "<unknown>",
"extendedAudienceFilter": "<unknown>",
"tags": ["<string>"],
"newCollectionId": "<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: '<unknown>',
description: '<unknown>',
content: '<unknown>',
plainContent: '<unknown>',
helpcenterCollection: '<string>',
author: '<string>',
project: '<string>',
isDraft: true,
docId: 123,
expectedVersion: 123,
lexorank: '<string>',
upvotes: '<unknown>',
targetAudience: 'all',
externalId: '<string>',
baseAudienceFilter: '<unknown>',
extendedAudienceFilter: '<unknown>',
tags: ['<string>'],
newCollectionId: '<string>'
})
};
fetch('https://api.gleap.io/v3/helpcenter/collections/{helpcenterCollectionId}/articles/{helpcenterArticleId}', 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.gleap.io/v3/helpcenter/collections/{helpcenterCollectionId}/articles/{helpcenterArticleId}",
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' => '<unknown>',
'description' => '<unknown>',
'content' => '<unknown>',
'plainContent' => '<unknown>',
'helpcenterCollection' => '<string>',
'author' => '<string>',
'project' => '<string>',
'isDraft' => true,
'docId' => 123,
'expectedVersion' => 123,
'lexorank' => '<string>',
'upvotes' => '<unknown>',
'targetAudience' => 'all',
'externalId' => '<string>',
'baseAudienceFilter' => '<unknown>',
'extendedAudienceFilter' => '<unknown>',
'tags' => [
'<string>'
],
'newCollectionId' => '<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://api.gleap.io/v3/helpcenter/collections/{helpcenterCollectionId}/articles/{helpcenterArticleId}"
payload := strings.NewReader("{\n \"title\": \"<unknown>\",\n \"description\": \"<unknown>\",\n \"content\": \"<unknown>\",\n \"plainContent\": \"<unknown>\",\n \"helpcenterCollection\": \"<string>\",\n \"author\": \"<string>\",\n \"project\": \"<string>\",\n \"isDraft\": true,\n \"docId\": 123,\n \"expectedVersion\": 123,\n \"lexorank\": \"<string>\",\n \"upvotes\": \"<unknown>\",\n \"targetAudience\": \"all\",\n \"externalId\": \"<string>\",\n \"baseAudienceFilter\": \"<unknown>\",\n \"extendedAudienceFilter\": \"<unknown>\",\n \"tags\": [\n \"<string>\"\n ],\n \"newCollectionId\": \"<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("https://api.gleap.io/v3/helpcenter/collections/{helpcenterCollectionId}/articles/{helpcenterArticleId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<unknown>\",\n \"description\": \"<unknown>\",\n \"content\": \"<unknown>\",\n \"plainContent\": \"<unknown>\",\n \"helpcenterCollection\": \"<string>\",\n \"author\": \"<string>\",\n \"project\": \"<string>\",\n \"isDraft\": true,\n \"docId\": 123,\n \"expectedVersion\": 123,\n \"lexorank\": \"<string>\",\n \"upvotes\": \"<unknown>\",\n \"targetAudience\": \"all\",\n \"externalId\": \"<string>\",\n \"baseAudienceFilter\": \"<unknown>\",\n \"extendedAudienceFilter\": \"<unknown>\",\n \"tags\": [\n \"<string>\"\n ],\n \"newCollectionId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gleap.io/v3/helpcenter/collections/{helpcenterCollectionId}/articles/{helpcenterArticleId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<unknown>\",\n \"description\": \"<unknown>\",\n \"content\": \"<unknown>\",\n \"plainContent\": \"<unknown>\",\n \"helpcenterCollection\": \"<string>\",\n \"author\": \"<string>\",\n \"project\": \"<string>\",\n \"isDraft\": true,\n \"docId\": 123,\n \"expectedVersion\": 123,\n \"lexorank\": \"<string>\",\n \"upvotes\": \"<unknown>\",\n \"targetAudience\": \"all\",\n \"externalId\": \"<string>\",\n \"baseAudienceFilter\": \"<unknown>\",\n \"extendedAudienceFilter\": \"<unknown>\",\n \"tags\": [\n \"<string>\"\n ],\n \"newCollectionId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"updatedAt": "<string>",
"createdAt": "<string>",
"sourceUsage": 123,
"version": 123,
"isDraft": true,
"targetAudience": "<string>",
"tags": [
"<string>"
],
"extendedAudienceFilter": "<unknown>",
"baseAudienceFilter": "<unknown>",
"docId": 123,
"author": {
"isValid": {},
"createFromHexString": {},
"createFromTime": {},
"generate": {},
"cacheHexString": "<unknown>"
},
"helpcenterCollection": {
"isValid": {},
"createFromHexString": {},
"createFromTime": {},
"generate": {},
"cacheHexString": "<unknown>"
},
"upvotes": "<unknown>",
"plainContent": "<unknown>",
"lexorank": "<string>",
"project": {
"isValid": {},
"createFromHexString": {},
"createFromTime": {},
"generate": {},
"cacheHexString": "<unknown>"
},
"externalId": "<string>",
"content": "<unknown>",
"title": "<unknown>",
"description": "<unknown>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Optimistic-concurrency token. When provided, the update is applied only if the
article's current version still equals this value; otherwise the server rejects
the write with 409 (and preserves the rejected content as a 'conflict' version).
When omitted, the save falls back to last-write-wins (keeps the existing editor
working until it is updated to send the token).
Response
200 - application/json
Ok
Generic types for Document:
- T - the type of _id
- TQueryHelpers - Object with any helpers that should be mixed into the Query type
- DocType - the type of the actual Document created
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I