API v1 ReferenceDocument Comments

Creates a new comment on the document with the specified id.

Creates a new comment on the document with the specified id. The user needs read permissions on the document to create a comment. A user can only create a comment for him/herself, except for admins and api users.

Path parameters

documentIdUUIDRequired
The id of the document.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
messagestringRequired>=1 character<=65000 characters
The message of the comment.
userIdUUID or nullOptional
The id of the user who created the comment. Optional. If not set, defaults to the current user.
previewslist of stringsOptional
The preview URLs to show a preview for.
isHiddenForConnectUsersboolean or nullOptional

(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 or nullOptional
Whether the comment has been resolved. Only available for comments on documents.
inReplyToCommentIdUUID or nullOptional
The parent comment this comment is a reply to.

Response

OK
idUUID or null
The id of the comment.
entityIdUUID or null
The id of the entity of the comment. Required.
entityTypestring or null
The type of the entity of the comment. Can be "projects", "tasks". Required.
entityobject or null
projectobject or null
taskobject or null
documentobject or null
createdOndatetime or null
The date this object was created.
createdByUUID or null
The id of the user who created this object.
userobject or null
updatedOndatetime or null
The date this object was last modified.
updatedByUUID or null
The id of the user who last modified this object.
mentionsobject or null
A mention is the tag of a user on a specific comment, so the user is notified.
reactionslist of objects or null
The reactions on a comment.
formattedMessagestring or null
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 or null
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.
resourceVersionlong or null
The version of the entity, updated on every modification, to the ticks in UTC. Not identical to UpdatedOn.
messagestring or null
The message of the comment.
userIdUUID or null
The id of the user who created the comment. Optional. If not set, defaults to the current user.
previewslist of strings or null
The preview URLs to show a preview for.
isHiddenForConnectUsersboolean or null
True if the comment should be hidden to connect users.
isResolvedboolean or null
Whether the comment has been resolved. Only available for comments on documents.
inReplyToCommentIdUUID or null
The parent comment this comment is a reply to.