patch https://api.productboard.com/v2/notes/
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/configuration
endpoint to discover available fields and possible patch operations.
Code examples
- Replace
<note-id>
with the ID of the note you want to update. - Replace
<your-token>
with a valid API token.
Update the name and owner of a note:
curl -X PATCH "https://api.productboard.com/v2/notes/<note-id>" \
-H "Authorization: Bearer <your-token>" \
-H "Content-Type: application/json" \
-d '{
"data": {
"fields": {
"name": "Updated note name",
"owner": {
"email": "[email protected]"
}
}
}
}'
Set owner using patch operation:
curl -X PATCH "https://api.productboard.com/v2/notes/<note-id>" \
-H "Authorization: Bearer <your-token>" \
-H "Content-Type: application/json" \
-d '{
"data": {
"patch": [
{
"op": "set",
"path": "owner",
"value": {
"email": "[email protected]"
}
}
]
}
}'
Clear owner using patch operation:
curl -X PATCH "https://api.productboard.com/v2/notes/<note-id>" \
-H "Authorization: Bearer <your-token>" \
-H "Content-Type: application/json" \
-d '{
"data": {
"patch": [
{
"op": "clear",
"path": "owner"
}
]
}
}'