notes-type field on a
record (and behind document pages). A record’s
notes field doesn’t hold the text. It holds the document’s doc_… id. Fetch the
document to get the content, rendered to markdown.
Attributes
string
Unique identifier, prefixed
doc_. This is the value a record’s notes-type
field holds.string
The document content rendered to markdown. Custral’s internal rich-text representation is never exposed.
Two ways to get a record’s notes as text: fetch the document directly by its
doc_ id (the Retrieve a document endpoint), or ask the record to inline
it with expand=notes on retrieve. One call, no
second round-trip. Both need the documents:read scope.Updating a document
Send markdown to the Update a document endpoint (PATCH) to replace a
document’s content in full, by its doc_ id. This is update-only, the
document must already exist (an unknown id returns document_not_found); there
is no create. The write merges into the document’s live state, so an editor with
the document open sees the change immediately. Requires the documents:write
scope. The markdown you send is the markdown you get back on the next read.