Objects - Charter Docs

Model tree

CommentCreateBody

CommentAttachment

CustomDisplayName

CommentUpdateBody

CommentCreateBody

The body of a create-comment request.

Field	Type	Description
`parent`	Parent	The page or block to comment on, starting a new discussion there.
`discussionId`	`string`	The ID of an existing discussion to reply to.
`richText`	RichText[]	The content of the comment, as rich text. max 100 items
`markdown`	`string`	The content of the comment as a Markdown string. Comments support inline formatting only — bold, italic, strikethrough, code, links, inline equations and mentions. Fenced code blocks, headings, lists, tables and blockquotes do not become structured blocks.
`attachments`	CommentAttachment[]	Files to attach. At most three. max 3 items
`displayName`	DisplayName	Who the comment appears to be from.

CommentAttachment

A file attached to a comment.

Field	Type	Description
`fileUploadId` *	`string`	The ID of a file upload whose status is `uploaded`.
`type`	`string`	Always `file_upload`.

DisplayName

Who the comment appears to be from.

Field	Type	Description
`type` *	`"integration" \| "user" \| "custom"`	Whether the comment is attributed to the integration, to the user the token acts for, or to a custom name.
`custom`	CustomDisplayName	The custom name, when `type` is `custom`.

CustomDisplayName

The name a custom-attributed comment is shown under.

Field	Type	Description
`name` *	`string`	The display name to use.

CommentUpdateBody

The body of an update-comment request.

Field	Type	Description
`richText`	RichText[]	The comment’s new content, as rich text. max 100 items
`markdown`	`string`	The content of the comment as a Markdown string. Comments support inline formatting only — bold, italic, strikethrough, code, links, inline equations and mentions. Fenced code blocks, headings, lists, tables and blockquotes do not become structured blocks.