API ReferenceNotes

Update Note

Update an existing note. The note being updated must be authored by the connected user. **Note:** The following legacy paths will continue to work until users are notified and migrated to the new naming: - `/projects/{projectId}/comments/{commentId}` - `/requests/{requestId}/comments/{commentId}` - `/clients/{clientId}/comments/{commentId}`

Authentication

x-api-keystring
API Key authentication via header

Path parameters

note_idstringRequired

Request

This endpoint expects an object.
bodystringRequired

Updated note text content.

Mention (@) tokens are supported in the body string using the format [Display Name|~id:USER_ID] (users), [Team Name|~team:TEAM_ID] (teams, notifies all members), or [Name|~agent:slug] (AI agents). The display-name portion is cosmetic; the trailing token drives the mention. A valid mention creates a feed notification for the mentioned recipient(s). The author is excluded from their own mention notifications.

Response

Note updated successfully
idinteger
Note identifier
notestring
Note text content
createdAtstringformat: "date-time"
Creation timestamp
updatedAtstringformat: "date-time"
Last update timestamp
authorobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error