Sign in

v1

latestOpenAPI 3.0.32026-07-13218142597.2 KB
Comment

Update inline comment

Update an inline comment. This can be used to update the body text of a comment and/or to resolve the comment

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

put/inline-comments/{comment-id}

Path parameters

comment-idinteger required

The ID of the comment to be retrieved.

Request body

resolvedboolean

Resolved state of the comment. Set to true to resolve the comment, set to false to reopen it. If matching the existing state (i.e. true -> resolved or false -> open/reopened) , no change will occur. A dangling comment cannot be updated.

Response

Returned if the inline comment is updated successfully.

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