curl --request PUT \
--url https://core-api.getaptly.com/api/knowledge/{id} \
--header 'Content-Type: application/json' \
--header 'x-token: <api-key>' \
--data '
{
"name": "Updated Lease Addendum Policy",
"html": "<p>Revised policy effective March 2026...</p>"
}
'import requests
url = "https://core-api.getaptly.com/api/knowledge/{id}"
payload = {
"name": "Updated Lease Addendum Policy",
"html": "<p>Revised policy effective March 2026...</p>"
}
headers = {
"x-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Updated Lease Addendum Policy',
html: '<p>Revised policy effective March 2026...</p>'
})
};
fetch('https://core-api.getaptly.com/api/knowledge/{id}', 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://core-api.getaptly.com/api/knowledge/{id}",
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' => 'Updated Lease Addendum Policy',
'html' => '<p>Revised policy effective March 2026...</p>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-token: <api-key>"
],
]);
$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://core-api.getaptly.com/api/knowledge/{id}"
payload := strings.NewReader("{\n \"name\": \"Updated Lease Addendum Policy\",\n \"html\": \"<p>Revised policy effective March 2026...</p>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-token", "<api-key>")
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://core-api.getaptly.com/api/knowledge/{id}")
.header("x-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Updated Lease Addendum Policy\",\n \"html\": \"<p>Revised policy effective March 2026...</p>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-api.getaptly.com/api/knowledge/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Updated Lease Addendum Policy\",\n \"html\": \"<p>Revised policy effective March 2026...</p>\"\n}"
response = http.request(request)
puts response.read_body{
"_id": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Update a knowledge document
Updates a knowledge document’s content and/or metadata. Only fields provided in the
request body are updated — omitted fields are left unchanged. Provide either html
or markdown, not both.
HTML format
Standard HTML (paragraphs, headings, lists, check lists, tables, quotes, code blocks,
images, links, bold/italic/underline/strike) is converted to the editor’s built-in
blocks. Aptly’s custom blocks and inline items are written as elements carrying a
type attribute plus one data-* attribute per property. Property names are the
camelCase names below written in kebab-case (cardId → data-card-id). Omitted
properties take their default (empty string unless noted). Text inside a block
element is ignored, except for the ai block. GET /api/knowledge/{id} returns
these elements in the same format, so its html can be edited and sent back.
Blocks — <div data-content-type="TYPE" ...></div>, placed between paragraphs:
| Type | Properties | Example |
|---|---|---|
card | cardId | <div data-content-type="card" data-card-id="CARD_ID"></div> |
task | taskId | <div data-content-type="task" data-task-id="TASK_ID"></div> |
contact | contactId | <div data-content-type="contact" data-contact-id="CONTACT_ID"></div> |
pageLink | documentId (another knowledge document) | <div data-content-type="pageLink" data-document-id="DOC_ID"></div> |
aptlyObject | objectId, objectType, aptletUuid | <div data-content-type="aptlyObject" data-object-id="ID" data-object-type="card" data-aptlet-uuid="BOARD_UUID"></div> |
embed | url, width (number, default 500), height (number, default 400) | <div data-content-type="embed" data-url="https://example.com" data-width="600" data-height="400"></div> |
mermaid | code (Mermaid diagram source) | <div data-content-type="mermaid" data-code="graph TD; A-->B"></div> |
formField | boardUuid, fieldUuid, fieldType, label, required (boolean, default false), cardId, boardName, boardIcon, boardColor | <div data-content-type="formField" data-board-uuid="BOARD_UUID" data-field-uuid="FIELD_UUID" data-label="Move-in date" data-required="true"></div> |
mergeFieldBlock | key, boardUuid, fieldUuid, cardId, label, boardName | <div data-content-type="mergeFieldBlock" data-key="KEY" data-label="Unit"></div> |
ai | prompt; the element’s text is the generated content | <div data-content-type="ai" data-prompt="Summarize the lease"><p>Generated text</p></div> |
Inline items — <span data-inline-content-type="TYPE" ...></span>, inside a
paragraph, heading, list item or table cell:
| Type | Properties | Example |
|---|---|---|
userMention | id, entityId, fullName (default Unknown), type (default user), mentionedBy | <span data-inline-content-type="userMention" data-id="USER_ID" data-full-name="Jane Doe"></span> |
cardMention | cardId | <span data-inline-content-type="cardMention" data-card-id="CARD_ID"></span> |
taskMention | taskId | <span data-inline-content-type="taskMention" data-task-id="TASK_ID"></span> |
mergeField | key, boardUuid, fieldUuid, cardId, label, boardName, fallback (omit for no fallback) | <span data-inline-content-type="mergeField" data-key="KEY" data-label="Rent"></span> |
Notes:
- Escape attribute values as HTML (
",&,<,>). true/falseand numbers in attributes are read as booleans and numbers.- An element without its
data-content-type/data-inline-content-typeattribute is treated as plain HTML, not as the custom item. - The
aiblock keeps only the text of its first<p>. - Multi-column layouts are not supported.
- Markdown cannot express custom blocks; use
htmlfor them.
curl --request PUT \
--url https://core-api.getaptly.com/api/knowledge/{id} \
--header 'Content-Type: application/json' \
--header 'x-token: <api-key>' \
--data '
{
"name": "Updated Lease Addendum Policy",
"html": "<p>Revised policy effective March 2026...</p>"
}
'import requests
url = "https://core-api.getaptly.com/api/knowledge/{id}"
payload = {
"name": "Updated Lease Addendum Policy",
"html": "<p>Revised policy effective March 2026...</p>"
}
headers = {
"x-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Updated Lease Addendum Policy',
html: '<p>Revised policy effective March 2026...</p>'
})
};
fetch('https://core-api.getaptly.com/api/knowledge/{id}', 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://core-api.getaptly.com/api/knowledge/{id}",
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' => 'Updated Lease Addendum Policy',
'html' => '<p>Revised policy effective March 2026...</p>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-token: <api-key>"
],
]);
$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://core-api.getaptly.com/api/knowledge/{id}"
payload := strings.NewReader("{\n \"name\": \"Updated Lease Addendum Policy\",\n \"html\": \"<p>Revised policy effective March 2026...</p>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-token", "<api-key>")
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://core-api.getaptly.com/api/knowledge/{id}")
.header("x-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Updated Lease Addendum Policy\",\n \"html\": \"<p>Revised policy effective March 2026...</p>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-api.getaptly.com/api/knowledge/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Updated Lease Addendum Policy\",\n \"html\": \"<p>Revised policy effective March 2026...</p>\"\n}"
response = http.request(request)
puts response.read_body{
"_id": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Authorizations
Path Parameters
The knowledge document ID.
Body
Response
Document updated.