Creates a new comment on the document with the specified id. | awork API

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

idUUIDOptional

The id of the comment.

entityIdUUIDOptional

The id of the entity of the comment. Required.

entityTypestring or nullOptional

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

entityobjectOptional

projectobjectOptional

taskobjectOptional

documentobjectOptional

createdOndatetimeOptional

The date this object was created.

createdByUUIDOptional

The id of the user who created this object.

userobjectOptional

updatedOndatetimeOptional

The date this object was last modified.

updatedByUUIDOptional

The id of the user who last modified this object.

mentionsobjectOptional

A mention is the tag of a user on a specific comment, so the user is notified.

reactionslist of objectsOptional

The reactions on a comment.

formattedMessagestring or nullOptional

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 nullOptional

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.

resourceVersionlongOptional

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

messagestring or nullOptional