Sign in

v1

latestOpenAPI 3.1.02026-08-066984441.1 MB
documentComments

Updates the comment with the specified id on the document with the specified id.

<Check title="Required Permissions" icon="key">To update a comment the user must either have at least read permissions on the specified document, be the creator of the comment or be admin.</Check>

put/documents/{documentId}/comments/{commentId}

Path parameters

documentIdstring uuid required

The id of the document.

commentIdstring uuid required

The id of the comment.

Headers

Authorizationstring required

Bearer authentication

Request body

messagestring required

The message of the comment.

userIdstring uuid nullable

The id of the user who created the comment. Optional. If not set, defaults to the current user.

previewsstring[] nullable

The preview URLs to show a preview for.

isHiddenForConnectUsersboolean nullable

(optional) Whether the comment is hidden for connect users. Providing a null value will not change the current state. By default, comments are not hidden for connect users.

isResolvedboolean nullable

Whether the comment has been resolved. Only available for comments on documents.

Response

OK

idstring uuid

The id of the comment.

entityIdstring uuid

The id of the entity of the comment. Required.

entityTypestring nullable

The type of the entity of the comment. Can be "projects", "tasks". Required.

createdOnstring date-time

The date this object was created.

createdBystring uuid

The id of the user who created this object.

agentIdstring uuid nullable

The agent that visibly authored this comment, when it was created by an agent run.

agentNameSnapshotstring nullable

The agent name captured when the comment was created.

updatedOnstring date-time

The date this object was last modified.

updatedBystring uuid

The id of the user who last modified this object.

formattedMessagestring nullable

The formatted and proccessed version of the comment message. E.g. mentions are in a human readable format. The formatted comment message is styled with html.

plainFormattedMessagestring nullable

The formatted and proccessed version of the comment message. E.g. mentions are in a human readable format. The formatted comment message is not styled.

resourceVersioninteger

The version of the entity, updated on every modification, to the ticks in UTC. Not identical to UpdatedOn.

messagestring nullable

The message of the comment.

userIdstring uuid nullable

The id of the user who created the comment. Optional. If not set, defaults to the current user.

previewsstring[] nullable

The preview URLs to show a preview for.

isHiddenForConnectUsersboolean

True if the comment should be hidden to connect users.

isResolvedboolean nullable

Whether the comment has been resolved. Only available for comments on documents.

inReplyToCommentIdstring uuid nullable

The parent comment this comment is a reply to.