TypeScript SDK
Comments
Update comment
Updates a comment by its comment_id.
PATCH
TypeScript SDK
Returns a comment object for the updated comment. A connection can only update comments that it created. Attempting to update a comment created by another user or connection will return a 404 error.Documentation Index
Fetch the complete documentation index at: https://developers.notion.com/llms.txt
Use this file to discover all available pages before exploring further.
Comment body format
The comment body can be provided in one of two formats:rich_text: An array of rich text objects that represent the updated content of the comment.markdown: A Markdown string. Supports inline formatting (bold, italic, strikethrough, inline code, links), inline equations, and mentions.
rich_text or markdown must be provided. Providing both or neither will return a validation error.
Errors
Each Public API endpoint can return several possible error codes. See the Error codes section of the Status codes documentation for more information.Reminder: Turn on connection comment capabilitiesConnection capabilities for reading and inserting comments are off by default.This endpoint requires a connection to have insert comment capabilities. Attempting to call this endpoint without insert comment capabilities will return an HTTP response with a 403 status code.For more information on connection capabilities, see the capabilities guide. To update your connection settings, visit the Developer portal.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The API version to use for this request. The latest version is 2026-03-11.
Available options:
2026-03-11 Path Parameters
The ID of the comment to update.
Body
application/json
- Option 1
- Option 2
An array of rich text objects that represent the updated content of the comment.
Maximum array length:
100- Text
- Mention
- Equation