Skip to main content
PATCH
/
api
/
v1
/
vault
/
records
/
{path}
curl -X PATCH \
  "/api/v1/vault/records/person/Alice%20Chen.md" \
  -H "Authorization: Bearer alf_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "set": {
      "status": "inactive",
      "updated": "2026-02-26T10:00:00Z"
    },
    "append": {
      "project": "[[project/Infrastructure Audit]]"
    },
    "body_append": "\n## Status Note\n\nMarked inactive as of Feb 26."
  }'

{
  "raw": "Edited person/Alice Chen.md"
}

​
Overview

Updates an existing record’s metadata fields and/or content body. You can set or replace fields, append to list fields, or update the content body.

​
Path Parameters

​
path
string
required
Relative path to the record (e.g., person/Alice Chen.md). URL-encode spaces and special characters.

​
Body Parameters

​
set
object
Key-value pairs to set in the record metadata. Replaces existing values for these fields.
​
append
object
Key-value pairs to append to list fields in metadata (e.g., adding a tag or project link).
​
body_append
string
Text to append to the content body.
​
body_stdin
string
Replace the content body entirely with this text.

​
Response

​
raw
string
Confirmation message. If the output is structured JSON, it is returned directly instead.

​
Request Example

curl -X PATCH \
  "/api/v1/vault/records/person/Alice%20Chen.md" \
  -H "Authorization: Bearer alf_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "set": {
      "status": "inactive",
      "updated": "2026-02-26T10:00:00Z"
    },
    "append": {
      "project": "[[project/Infrastructure Audit]]"
    },
    "body_append": "\n## Status Note\n\nMarked inactive as of Feb 26."
  }'

​
Response Example

{
  "raw": "Edited person/Alice Chen.md"
}