Notion: Comments schemas
5 Notion schemas with complete fields and constraints.
← Comments operations · All schemas
Create a comment — response body — object comment parent
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Create a comment — response body — object comment parent Page Id |
$ (anyOf 2) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
block_id | string | Required within parent | Format: uuid |
type | string | Required within parent | Always `block_id` Must equal: block_id |
Create a comment — response body — object comment parent Page Id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
page_id | string | Required within parent | Format: uuid |
type | string | Required within parent | Always `page_id` Must equal: page_id |
Create a comment — response body — object comment — comment Object Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
attachments | array | Optional | Any file attachments associated with the comment. Maximum items: 100 |
attachments[] | object | Each item | Additional keys: allowed |
attachments[].category | string | Required within parent | One of: `audio`, `image`, `pdf`, `productivity`, `video` Known values: audio, image, pdf, productivity, video |
attachments[].file | Model | Required within parent | Expand Get agent — response body — icon value File file |
created_by | Model | Required within parent | Expand Update page — response body — object page created by The user who created the comment. |
created_time | string | Required within parent | The time when the comment was created. Format: date-time |
discussion_id | string | Required within parent | The ID of the discussion thread this comment belongs to. Format: uuid |
display_name | object | Required within parent | The display name of the comment. Additional keys: allowed |
display_name.resolved_name | JSON | Required within parent | |
display_name.resolved_name (anyOf 1) | string | Alternative | |
display_name.resolved_name (anyOf 2) | null | Alternative | |
display_name.type | string | Required within parent | One of: `custom`, `user`, `integration` Known values: custom, user, integration |
has_pending_attachments | boolean | Required within parent | Whether 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. |
id | string | Required within parent | The ID of the comment. Format: uuid |
last_edited_time | string | Required within parent | The time when the comment was last edited. Format: date-time |
object | string | Required within parent | The comment object type name. Must equal: comment |
original_content_deleted | boolean | Required within parent | Whether this comment's original content was deleted. |
parent | Model | Required within parent | Expand Create a comment — response body — object comment parent The parent of the comment. |
property_id | string | Optional | The 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_text | array | Required within parent | The rich text content of the comment. Maximum items: 100 |
rich_text[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
id | string | Required within parent | The ID of the comment. Format: uuid |
object | string | Required within parent | The comment object type name. Must equal: comment |