Updates the values of one or more fields for an existing note.
You can update fields using either:
- Field Updates: Replace entire field values using the
fieldsobject - Patch Operations: Perform granular updates using the
patcharray with operations (set,clear,addItems,removeItems)
Use this endpoint to update note metadata such as name, owner, tags, or content.
Use the /v2/notes/configurations endpoint to discover available fields and possible patch operations.
Patch Operations
The following patch operations are supported:
| Operation | Description | Supported Fields |
|---|---|---|
set | Set a field to a specific value | All fields |
clear | Clear/reset a field to its default value | owner, tags |
addItems | Add items to array fields | tags, content (conversation) |
removeItems | Remove items from array fields | tags, content (conversation) |
Field-specific patch operation support:
- owner:
set,clear - tags:
set,clear,addItems,removeItems - archived:
set - processed:
set - name:
set - content (simple):
set - content (conversation):
set,addItems,removeItems
Known Limitations
Content updates for notes with linked features: Notes that have content linked to features (via highlights/snippets) cannot have their content field updated. Attempting to update the content will return a 422 Unprocessable Entity error with code validation.forbidden. You can still update other fields such as name, owner, tags, archived, and processed on these notes.
Archive and Processed Field Behavior: When you set archived to false, the note will be set to processed automatically by the system. This is a known limitation where unarchiving a note triggers processing regardless of the previous processed state. The processed field will reflect the actual processing status after the unarchive operation.