v1

latestOpenAPI 3.1.1Productboard Proprietary2026-07-2453178243.2 KB
notes

Update note

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 fields object
  • Patch Operations: Perform granular updates using the patch array 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:

OperationDescriptionSupported Fields
setSet a field to a specific valueAll fields
clearClear/reset a field to its default valueowner, tags
addItemsAdd items to array fieldstags, content (conversationNote)
removeItemsRemove items from array fieldstags, content (conversationNote)

Field-specific patch operation support:

  • owner: set, clear
  • tags: set, clear, addItems, removeItems
  • archived: set
  • processed: set
  • name: set
  • content (textNote): set
  • content (conversationNote): 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.

patch/notes/{id}

Path parameters

idstring uuid required

Note identifier.

Request body

Example request

{
  "summary": "Update note fields",
  "value": {
    "data": {
      "fields": {
        "name": "New name",
        "tags": [
          "sales",
          "onboarding"
        ],
        "content": "<p>Updated content of the note</p>"
      }
    }
  }
}

Response

Note updated successfully

Example response

{
  "data": {
    "type": "textNote",
    "links": {
      "self": "https://api.productboard.com/v2/notes/123e4567-e89b-12d3-a456-426614174000",
      "html": "https://example.productboard.com/all-notes/notes/42"
    }
  }
}