Writes
Partial-update a note
AIP-134/161 PATCH. Query update_mask is required and comma-separated (title, content, folder, tags, status, frontmatter.<key>). Body is the partial resource plus agent_id and optional expect_version_id. Missing or unknown mask is 400 INVALID_UPDATE_MASK. Write-plane: review, budget, and Idempotency-Key apply. Applied receipts embed note (GET shape without lines).
PATCH
/
v1
/
notes
/
{note}
Partial-update a note
curl --request PATCH \
--url https://api.elanotes.com/v1/notes/{note} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"agent_id": "unknown",
"content": "<string>",
"expect_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"folder": "<string>",
"frontmatter": {},
"tags": [
"<string>"
],
"title": "<string>"
}
'import requests
url = "https://api.elanotes.com/v1/notes/{note}"
payload = {
"agent_id": "unknown",
"content": "<string>",
"expect_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"folder": "<string>",
"frontmatter": {},
"tags": ["<string>"],
"title": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
agent_id: 'unknown',
content: '<string>',
expect_version_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
folder: '<string>',
frontmatter: {},
tags: ['<string>'],
title: '<string>'
})
};
fetch('https://api.elanotes.com/v1/notes/{note}', 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.elanotes.com/v1/notes/{note}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'agent_id' => 'unknown',
'content' => '<string>',
'expect_version_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'folder' => '<string>',
'frontmatter' => [
],
'tags' => [
'<string>'
],
'title' => '<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.elanotes.com/v1/notes/{note}"
payload := strings.NewReader("{\n \"agent_id\": \"unknown\",\n \"content\": \"<string>\",\n \"expect_version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"folder\": \"<string>\",\n \"frontmatter\": {},\n \"tags\": [\n \"<string>\"\n ],\n \"title\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.elanotes.com/v1/notes/{note}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"agent_id\": \"unknown\",\n \"content\": \"<string>\",\n \"expect_version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"folder\": \"<string>\",\n \"frontmatter\": {},\n \"tags\": [\n \"<string>\"\n ],\n \"title\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.elanotes.com/v1/notes/{note}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agent_id\": \"unknown\",\n \"content\": \"<string>\",\n \"expect_version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"folder\": \"<string>\",\n \"frontmatter\": {},\n \"tags\": [\n \"<string>\"\n ],\n \"title\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"pending_id": "<string>",
"slug": "<string>",
"status": "applied",
"committed_seq": 0,
"content_hash": "<string>",
"flow_back_error": "<string>",
"links_failed": [
{
"reason": "<string>",
"slug": "<string>"
}
],
"links_updated": 0,
"note": {
"content_hash": "<string>",
"note_id": "<string>",
"observed_at": "<string>",
"slug": "<string>",
"status": "<string>",
"title": "<string>",
"version_id": "<string>",
"visibility": "<string>"
},
"note_id": "<string>",
"renamed": true,
"unchanged": true,
"version_id": "<string>"
}{
"details": [
{
"@type": "<string>"
}
],
"error": "<string>",
"help": "<string>",
"hint": "<string>",
"message": "<string>",
"reason": "<string>",
"requestId": "<string>",
"statusCode": 0
}{
"details": [
{
"@type": "<string>"
}
],
"error": "<string>",
"help": "<string>",
"hint": "<string>",
"message": "<string>",
"reason": "<string>",
"requestId": "<string>",
"statusCode": 0
}{
"details": [
{
"@type": "<string>"
}
],
"error": "<string>",
"help": "<string>",
"hint": "<string>",
"message": "<string>",
"reason": "<string>",
"requestId": "<string>",
"statusCode": 0
}{
"details": [
{
"@type": "<string>"
}
],
"error": "<string>",
"help": "<string>",
"hint": "<string>",
"message": "<string>",
"reason": "<string>",
"requestId": "<string>",
"statusCode": 0
}{
"details": [
{
"@type": "<string>"
}
],
"error": "<string>",
"help": "<string>",
"hint": "<string>",
"message": "<string>",
"reason": "<string>",
"requestId": "<string>",
"statusCode": 0
}{
"details": [
{
"@type": "<string>"
}
],
"error": "<string>",
"help": "<string>",
"hint": "<string>",
"message": "<string>",
"reason": "<string>",
"requestId": "<string>",
"statusCode": 0
}Authorizations
Static bearer, WorkOS JWT, or open local when AUTH_REQUIRED is off and no static tokens are set. The token selects the vault; paths do not include vault_id.
Path Parameters
Minimum string length:
1Query Parameters
Body
application/json
Required string length:
1 - 100Required string length:
1 - 1000000Pattern:
^([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)$Maximum string length:
500Show child attributes
Show child attributes
Available options:
active, archived Maximum array length:
50Required string length:
1 - 100Maximum string length:
500Response
Default Response
Available options:
applied, queued Required range:
-9007199254740991 <= x <= 9007199254740991Show child attributes
Show child attributes
Required range:
-9007199254740991 <= x <= 9007199254740991Show child attributes
Show child attributes
⌘I
Partial-update a note
curl --request PATCH \
--url https://api.elanotes.com/v1/notes/{note} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"agent_id": "unknown",
"content": "<string>",
"expect_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"folder": "<string>",
"frontmatter": {},
"tags": [
"<string>"
],
"title": "<string>"
}
'import requests
url = "https://api.elanotes.com/v1/notes/{note}"
payload = {
"agent_id": "unknown",
"content": "<string>",
"expect_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"folder": "<string>",
"frontmatter": {},
"tags": ["<string>"],
"title": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
agent_id: 'unknown',
content: '<string>',
expect_version_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
folder: '<string>',
frontmatter: {},
tags: ['<string>'],
title: '<string>'
})
};
fetch('https://api.elanotes.com/v1/notes/{note}', 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.elanotes.com/v1/notes/{note}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'agent_id' => 'unknown',
'content' => '<string>',
'expect_version_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'folder' => '<string>',
'frontmatter' => [
],
'tags' => [
'<string>'
],
'title' => '<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.elanotes.com/v1/notes/{note}"
payload := strings.NewReader("{\n \"agent_id\": \"unknown\",\n \"content\": \"<string>\",\n \"expect_version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"folder\": \"<string>\",\n \"frontmatter\": {},\n \"tags\": [\n \"<string>\"\n ],\n \"title\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.elanotes.com/v1/notes/{note}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"agent_id\": \"unknown\",\n \"content\": \"<string>\",\n \"expect_version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"folder\": \"<string>\",\n \"frontmatter\": {},\n \"tags\": [\n \"<string>\"\n ],\n \"title\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.elanotes.com/v1/notes/{note}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agent_id\": \"unknown\",\n \"content\": \"<string>\",\n \"expect_version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"folder\": \"<string>\",\n \"frontmatter\": {},\n \"tags\": [\n \"<string>\"\n ],\n \"title\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"pending_id": "<string>",
"slug": "<string>",
"status": "applied",
"committed_seq": 0,
"content_hash": "<string>",
"flow_back_error": "<string>",
"links_failed": [
{
"reason": "<string>",
"slug": "<string>"
}
],
"links_updated": 0,
"note": {
"content_hash": "<string>",
"note_id": "<string>",
"observed_at": "<string>",
"slug": "<string>",
"status": "<string>",
"title": "<string>",
"version_id": "<string>",
"visibility": "<string>"
},
"note_id": "<string>",
"renamed": true,
"unchanged": true,
"version_id": "<string>"
}{
"details": [
{
"@type": "<string>"
}
],
"error": "<string>",
"help": "<string>",
"hint": "<string>",
"message": "<string>",
"reason": "<string>",
"requestId": "<string>",
"statusCode": 0
}{
"details": [
{
"@type": "<string>"
}
],
"error": "<string>",
"help": "<string>",
"hint": "<string>",
"message": "<string>",
"reason": "<string>",
"requestId": "<string>",
"statusCode": 0
}{
"details": [
{
"@type": "<string>"
}
],
"error": "<string>",
"help": "<string>",
"hint": "<string>",
"message": "<string>",
"reason": "<string>",
"requestId": "<string>",
"statusCode": 0
}{
"details": [
{
"@type": "<string>"
}
],
"error": "<string>",
"help": "<string>",
"hint": "<string>",
"message": "<string>",
"reason": "<string>",
"requestId": "<string>",
"statusCode": 0
}{
"details": [
{
"@type": "<string>"
}
],
"error": "<string>",
"help": "<string>",
"hint": "<string>",
"message": "<string>",
"reason": "<string>",
"requestId": "<string>",
"statusCode": 0
}{
"details": [
{
"@type": "<string>"
}
],
"error": "<string>",
"help": "<string>",
"hint": "<string>",
"message": "<string>",
"reason": "<string>",
"requestId": "<string>",
"statusCode": 0
}
