Sign in

v1

latestOpenAPI 3.0.32026-07-13218142597.2 KB
Comment

Create inline comment

Create an inline comment. This can be at the top level (specifying pageId or blogPostId in the request body) or as a reply (specifying parentCommentId in the request body). Note the inlineCommentProperties object in the request body is used to select the text the inline comment should be tied to. This is what determines the text highlighting when viewing a page in Confluence.

Permissions required: Permission to view the content of the page or blogpost and its corresponding space. Permission to create comments in the space.

post/inline-comments

Request body

blogPostIdstring

ID of the containing blog post, if intending to create a top level footer comment. Do not provide if creating a reply.

pageIdstring

ID of the containing page, if intending to create a top level footer comment. Do not provide if creating a reply.

parentCommentIdstring

ID of the parent comment, if intending to create a reply. Do not provide if creating a top level comment.

Response

Returned if the inline comment is created.

idstring

ID of the comment.

status'current' | 'draft' | 'archived' | 'historical' | 'trashed' | 'deleted' | 'any'

The status of the content.

titlestring

Title of the comment.

blogPostIdstring

ID of the blog post containing the comment if the comment is on a blog post.

pageIdstring

ID of the page containing the comment if the comment is on a page.

parentCommentIdstring

ID of the parent comment if the comment is a reply.

resolutionLastModifierIdstring

Atlassian Account ID of last person who modified the resolve state of the comment. Null until comment is resolved or reopened.

resolutionLastModifiedAtstring date-time

Timestamp of the last modification to the comment's resolution status. Null until comment is resolved or reopened.

resolutionStatus'open' | 'reopened' | 'resolved' | 'dangling'

Inline comment resolution status