Skip to content

Notion: Comments schemas

5 Notion schemas with complete fields and constraints.

← Comments operations · All schemas

Create a comment — response body — object comment parent

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Create a comment — response body — object comment parent Page Id
$ (anyOf 2)ModelAlternativeExpand Create a comment — response body — object comment parent Block Id

Referenced models: Create a comment — response body — object comment parent Block Id, Create a comment — response body — object comment parent Page Id

Create a comment — response body — object comment parent Block Id

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
block_idstringRequired within parentFormat: uuid
typestringRequired within parentAlways `block_id`
Must equal: block_id

Create a comment — response body — object comment parent Page Id

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
page_idstringRequired within parentFormat: uuid
typestringRequired within parentAlways `page_id`
Must equal: page_id

Create a comment — response body — object comment — comment Object Response

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
attachmentsarrayOptionalAny file attachments associated with the comment.
Maximum items: 100
attachments[]objectEach itemAdditional keys: allowed
attachments[].categorystringRequired within parentOne of: `audio`, `image`, `pdf`, `productivity`, `video`
Known values: audio, image, pdf, productivity, video
attachments[].fileModelRequired within parentExpand Get agent — response body — icon value File file
created_byModelRequired within parentExpand Update page — response body — object page created by
The user who created the comment.
created_timestringRequired within parentThe time when the comment was created.
Format: date-time
discussion_idstringRequired within parentThe ID of the discussion thread this comment belongs to.
Format: uuid
display_nameobjectRequired within parentThe display name of the comment.
Additional keys: allowed
display_name.resolved_nameJSONRequired within parent
display_name.resolved_name (anyOf 1)stringAlternative
display_name.resolved_name (anyOf 2)nullAlternative
display_name.typestringRequired within parentOne of: `custom`, `user`, `integration`
Known values: custom, user, integration
has_pending_attachmentsbooleanRequired within parentWhether any file attachments on this comment are still uploading. Pending files are not listed in `attachments` yet. A `comment.updated` webhook is sent when each upload finishes.
idstringRequired within parentThe ID of the comment.
Format: uuid
last_edited_timestringRequired within parentThe time when the comment was last edited.
Format: date-time
objectstringRequired within parentThe comment object type name.
Must equal: comment
original_content_deletedbooleanRequired within parentWhether this comment's original content was deleted.
parentModelRequired within parentExpand Create a comment — response body — object comment parent
The parent of the comment.
property_idstringOptionalThe ID of the database property the comment is on, for comments on a page property. Matches the property's `id` in the page object. Omitted for other comments.
rich_textarrayRequired within parentThe rich text content of the comment.
Maximum items: 100
rich_text[]ModelEach itemExpand Retrieve a page property item — response body — value Title title

Referenced models: Create a comment — response body — object comment parent, Get agent — response body — icon value File file, Update page — response body — object page created by, Retrieve a page property item — response body — value Title title

Create a comment — response body — object comment — partial Comment Object Response

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
idstringRequired within parentThe ID of the comment.
Format: uuid
objectstringRequired within parentThe comment object type name.
Must equal: comment

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.