Update a custom component.
curl --request PUT \
--url https://api.gleap.io/v3/custom-components/{customComponentId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'project: <project>' \
--data '
{
"name": "<string>",
"schema": "<unknown>",
"template": "<string>",
"description": "<string>",
"whenToUse": "<string>",
"exampleData": "<unknown>",
"isPublished": true
}
'import requests
url = "https://api.gleap.io/v3/custom-components/{customComponentId}"
payload = {
"name": "<string>",
"schema": "<unknown>",
"template": "<string>",
"description": "<string>",
"whenToUse": "<string>",
"exampleData": "<unknown>",
"isPublished": True
}
headers = {
"project": "<project>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
project: '<project>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
schema: '<unknown>',
template: '<string>',
description: '<string>',
whenToUse: '<string>',
exampleData: '<unknown>',
isPublished: true
})
};
fetch('https://api.gleap.io/v3/custom-components/{customComponentId}', 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/custom-components/{customComponentId}",
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([
'name' => '<string>',
'schema' => '<unknown>',
'template' => '<string>',
'description' => '<string>',
'whenToUse' => '<string>',
'exampleData' => '<unknown>',
'isPublished' => true
]),
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/custom-components/{customComponentId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"schema\": \"<unknown>\",\n \"template\": \"<string>\",\n \"description\": \"<string>\",\n \"whenToUse\": \"<string>\",\n \"exampleData\": \"<unknown>\",\n \"isPublished\": true\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.gleap.io/v3/custom-components/{customComponentId}")
.header("project", "<project>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"schema\": \"<unknown>\",\n \"template\": \"<string>\",\n \"description\": \"<string>\",\n \"whenToUse\": \"<string>\",\n \"exampleData\": \"<unknown>\",\n \"isPublished\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gleap.io/v3/custom-components/{customComponentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["project"] = '<project>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"schema\": \"<unknown>\",\n \"template\": \"<string>\",\n \"description\": \"<string>\",\n \"whenToUse\": \"<string>\",\n \"exampleData\": \"<unknown>\",\n \"isPublished\": true\n}"
response = http.request(request)
puts response.read_body{
"updatedAt": "<string>",
"createdAt": "<string>",
"isPublished": true,
"exampleData": "<unknown>",
"sanitizedTemplate": "<string>",
"template": "<string>",
"whenToUse": "<string>",
"project": {
"isValid": {},
"createFromHexString": {},
"createFromTime": {},
"generate": {},
"cacheHexString": "<unknown>"
},
"description": "<string>",
"name": "<string>",
"schema": "<unknown>",
"createdBy": "<string>"
}Custom components
Update a custom component.
Update a custom component. The template is sanitized server-side; unsafe markup is rejected with 400.
PUT
/
custom-components
/
{customComponentId}
Update a custom component.
curl --request PUT \
--url https://api.gleap.io/v3/custom-components/{customComponentId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'project: <project>' \
--data '
{
"name": "<string>",
"schema": "<unknown>",
"template": "<string>",
"description": "<string>",
"whenToUse": "<string>",
"exampleData": "<unknown>",
"isPublished": true
}
'import requests
url = "https://api.gleap.io/v3/custom-components/{customComponentId}"
payload = {
"name": "<string>",
"schema": "<unknown>",
"template": "<string>",
"description": "<string>",
"whenToUse": "<string>",
"exampleData": "<unknown>",
"isPublished": True
}
headers = {
"project": "<project>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
project: '<project>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
schema: '<unknown>',
template: '<string>',
description: '<string>',
whenToUse: '<string>',
exampleData: '<unknown>',
isPublished: true
})
};
fetch('https://api.gleap.io/v3/custom-components/{customComponentId}', 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/custom-components/{customComponentId}",
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([
'name' => '<string>',
'schema' => '<unknown>',
'template' => '<string>',
'description' => '<string>',
'whenToUse' => '<string>',
'exampleData' => '<unknown>',
'isPublished' => true
]),
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/custom-components/{customComponentId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"schema\": \"<unknown>\",\n \"template\": \"<string>\",\n \"description\": \"<string>\",\n \"whenToUse\": \"<string>\",\n \"exampleData\": \"<unknown>\",\n \"isPublished\": true\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.gleap.io/v3/custom-components/{customComponentId}")
.header("project", "<project>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"schema\": \"<unknown>\",\n \"template\": \"<string>\",\n \"description\": \"<string>\",\n \"whenToUse\": \"<string>\",\n \"exampleData\": \"<unknown>\",\n \"isPublished\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gleap.io/v3/custom-components/{customComponentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["project"] = '<project>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"schema\": \"<unknown>\",\n \"template\": \"<string>\",\n \"description\": \"<string>\",\n \"whenToUse\": \"<string>\",\n \"exampleData\": \"<unknown>\",\n \"isPublished\": true\n}"
response = http.request(request)
puts response.read_body{
"updatedAt": "<string>",
"createdAt": "<string>",
"isPublished": true,
"exampleData": "<unknown>",
"sanitizedTemplate": "<string>",
"template": "<string>",
"whenToUse": "<string>",
"project": {
"isValid": {},
"createFromHexString": {},
"createFromTime": {},
"generate": {},
"cacheHexString": "<unknown>"
},
"description": "<string>",
"name": "<string>",
"schema": "<unknown>",
"createdBy": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Path Parameters
Body
application/json
Unique kebab-case identifier within the project (^[a-z][a-z0-9-]{1,49}$, 2-50 chars).
HTML template, max 20000 characters. Sanitized server-side; unsafe markup is rejected with 400.
The sanitized result is returned as the read-only sanitizedTemplate field.
Short description shown to the AI, max 120 characters.
Guidance for the AI on when to render this component, max 500 characters.
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