Skip to main content
Replaces a document’s title, its summary, or both. This overwrites whatever is stored, including text a person wrote in the app, so read the document with get_document first and only write when you mean to replace what is there.

Input

string (uuid)
required
Id of the document to update.
string
New title. Replaces the existing title. Surrounding whitespace is trimmed; 1 to 200 characters after trimming.
string
New summary. Replaces the existing summary; pass an empty string to clear it. Maximum 2000 characters.

Output

object
required

Notes

  • Pass at least one of title or summary. A call with neither is rejected.
  • Fields you leave out are untouched. Fields you pass are replaced outright — there is no merge or append, and human edits are overwritten like any other value.
  • A document outside the bound workspace reads as not found and is never written to.