Create a new collection
curl --request POST \
--url https://api.gleap.io/v3/helpcenter/collections \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'project: <project>' \
--data '
{
"title": "<unknown>",
"description": "<unknown>",
"iconUrl": "<string>",
"project": "<string>",
"lexorank": "<string>",
"docId": 123,
"parent": "<string>",
"externalId": "<string>",
"targetAudience": "all",
"baseAudienceFilter": "<unknown>",
"extendedAudienceFilter": "<unknown>"
}
'import requests
url = "https://api.gleap.io/v3/helpcenter/collections"
payload = {
"title": "<unknown>",
"description": "<unknown>",
"iconUrl": "<string>",
"project": "<string>",
"lexorank": "<string>",
"docId": 123,
"parent": "<string>",
"externalId": "<string>",
"targetAudience": "all",
"baseAudienceFilter": "<unknown>",
"extendedAudienceFilter": "<unknown>"
}
headers = {
"project": "<project>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
project: '<project>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
title: '<unknown>',
description: '<unknown>',
iconUrl: '<string>',
project: '<string>',
lexorank: '<string>',
docId: 123,
parent: '<string>',
externalId: '<string>',
targetAudience: 'all',
baseAudienceFilter: '<unknown>',
extendedAudienceFilter: '<unknown>'
})
};
fetch('https://api.gleap.io/v3/helpcenter/collections', 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",
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([
'title' => '<unknown>',
'description' => '<unknown>',
'iconUrl' => '<string>',
'project' => '<string>',
'lexorank' => '<string>',
'docId' => 123,
'parent' => '<string>',
'externalId' => '<string>',
'targetAudience' => 'all',
'baseAudienceFilter' => '<unknown>',
'extendedAudienceFilter' => '<unknown>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"project: <project>"
],
]);
$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"
payload := strings.NewReader("{\n \"title\": \"<unknown>\",\n \"description\": \"<unknown>\",\n \"iconUrl\": \"<string>\",\n \"project\": \"<string>\",\n \"lexorank\": \"<string>\",\n \"docId\": 123,\n \"parent\": \"<string>\",\n \"externalId\": \"<string>\",\n \"targetAudience\": \"all\",\n \"baseAudienceFilter\": \"<unknown>\",\n \"extendedAudienceFilter\": \"<unknown>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("project", "<project>")
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.gleap.io/v3/helpcenter/collections")
.header("project", "<project>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<unknown>\",\n \"description\": \"<unknown>\",\n \"iconUrl\": \"<string>\",\n \"project\": \"<string>\",\n \"lexorank\": \"<string>\",\n \"docId\": 123,\n \"parent\": \"<string>\",\n \"externalId\": \"<string>\",\n \"targetAudience\": \"all\",\n \"baseAudienceFilter\": \"<unknown>\",\n \"extendedAudienceFilter\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gleap.io/v3/helpcenter/collections")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["project"] = '<project>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<unknown>\",\n \"description\": \"<unknown>\",\n \"iconUrl\": \"<string>\",\n \"project\": \"<string>\",\n \"lexorank\": \"<string>\",\n \"docId\": 123,\n \"parent\": \"<string>\",\n \"externalId\": \"<string>\",\n \"targetAudience\": \"all\",\n \"baseAudienceFilter\": \"<unknown>\",\n \"extendedAudienceFilter\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"updatedAt": "<string>",
"createdAt": "<string>",
"targetAudience": "<string>",
"iconUrl": "<string>",
"extendedAudienceFilter": "<unknown>",
"baseAudienceFilter": "<unknown>",
"docId": 123,
"lexorank": "<string>",
"project": {
"isValid": {},
"createFromHexString": {},
"createFromTime": {},
"generate": {},
"cacheHexString": "<unknown>"
},
"parent": {
"isValid": {},
"createFromHexString": {},
"createFromTime": {},
"generate": {},
"cacheHexString": "<unknown>"
},
"externalId": "<string>",
"title": "<unknown>",
"description": "<unknown>"
}Help center collections
Create a new collection
POST
/
helpcenter
/
collections
Create a new collection
curl --request POST \
--url https://api.gleap.io/v3/helpcenter/collections \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'project: <project>' \
--data '
{
"title": "<unknown>",
"description": "<unknown>",
"iconUrl": "<string>",
"project": "<string>",
"lexorank": "<string>",
"docId": 123,
"parent": "<string>",
"externalId": "<string>",
"targetAudience": "all",
"baseAudienceFilter": "<unknown>",
"extendedAudienceFilter": "<unknown>"
}
'import requests
url = "https://api.gleap.io/v3/helpcenter/collections"
payload = {
"title": "<unknown>",
"description": "<unknown>",
"iconUrl": "<string>",
"project": "<string>",
"lexorank": "<string>",
"docId": 123,
"parent": "<string>",
"externalId": "<string>",
"targetAudience": "all",
"baseAudienceFilter": "<unknown>",
"extendedAudienceFilter": "<unknown>"
}
headers = {
"project": "<project>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
project: '<project>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
title: '<unknown>',
description: '<unknown>',
iconUrl: '<string>',
project: '<string>',
lexorank: '<string>',
docId: 123,
parent: '<string>',
externalId: '<string>',
targetAudience: 'all',
baseAudienceFilter: '<unknown>',
extendedAudienceFilter: '<unknown>'
})
};
fetch('https://api.gleap.io/v3/helpcenter/collections', 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",
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([
'title' => '<unknown>',
'description' => '<unknown>',
'iconUrl' => '<string>',
'project' => '<string>',
'lexorank' => '<string>',
'docId' => 123,
'parent' => '<string>',
'externalId' => '<string>',
'targetAudience' => 'all',
'baseAudienceFilter' => '<unknown>',
'extendedAudienceFilter' => '<unknown>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"project: <project>"
],
]);
$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"
payload := strings.NewReader("{\n \"title\": \"<unknown>\",\n \"description\": \"<unknown>\",\n \"iconUrl\": \"<string>\",\n \"project\": \"<string>\",\n \"lexorank\": \"<string>\",\n \"docId\": 123,\n \"parent\": \"<string>\",\n \"externalId\": \"<string>\",\n \"targetAudience\": \"all\",\n \"baseAudienceFilter\": \"<unknown>\",\n \"extendedAudienceFilter\": \"<unknown>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("project", "<project>")
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.gleap.io/v3/helpcenter/collections")
.header("project", "<project>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<unknown>\",\n \"description\": \"<unknown>\",\n \"iconUrl\": \"<string>\",\n \"project\": \"<string>\",\n \"lexorank\": \"<string>\",\n \"docId\": 123,\n \"parent\": \"<string>\",\n \"externalId\": \"<string>\",\n \"targetAudience\": \"all\",\n \"baseAudienceFilter\": \"<unknown>\",\n \"extendedAudienceFilter\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gleap.io/v3/helpcenter/collections")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["project"] = '<project>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<unknown>\",\n \"description\": \"<unknown>\",\n \"iconUrl\": \"<string>\",\n \"project\": \"<string>\",\n \"lexorank\": \"<string>\",\n \"docId\": 123,\n \"parent\": \"<string>\",\n \"externalId\": \"<string>\",\n \"targetAudience\": \"all\",\n \"baseAudienceFilter\": \"<unknown>\",\n \"extendedAudienceFilter\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"updatedAt": "<string>",
"createdAt": "<string>",
"targetAudience": "<string>",
"iconUrl": "<string>",
"extendedAudienceFilter": "<unknown>",
"baseAudienceFilter": "<unknown>",
"docId": 123,
"lexorank": "<string>",
"project": {
"isValid": {},
"createFromHexString": {},
"createFromTime": {},
"generate": {},
"cacheHexString": "<unknown>"
},
"parent": {
"isValid": {},
"createFromHexString": {},
"createFromTime": {},
"generate": {},
"cacheHexString": "<unknown>"
},
"externalId": "<string>",
"title": "<unknown>",
"description": "<unknown>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Body
application/json
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
⌘I