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

import requests
url = "https://api.awork.com/api/v1/documents/documentId/comments"
payload = { "message": "Hey team, the customer loved the latest designs!" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "id": "a3f1c9d2-4b7e-4f8a-9c3d-2e5b7f9a1c2d",
  "entityId": "b7d9e8f1-2c3a-4d5e-8f7b-9a0c1d2e3f4b",
  "entityType": "tasks",
  "entity": {
    "id": "b7d9e8f1-2c3a-4d5e-8f7b-9a0c1d2e3f4b",
    "name": "Design Review Task"
  },
  "project": {
    "id": "c1d2e3f4-b5a6-7c8d-9e0f-1a2b3c4d5e6f",
    "name": "Website Redesign Project"
  },
  "task": {
    "id": "b7d9e8f1-2c3a-4d5e-8f7b-9a0c1d2e3f4b",
    "name": "Review New UI Mockups"
  },
  "document": {
    "id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f9a",
    "name": "UI Design Specifications"
  },
  "createdOn": "2024-01-15T09:30:00Z",
  "createdBy": "e1f2a3b4-c5d6-7e8f-9012-3456789abcde",
  "user": {
    "id": "e1f2a3b4-c5d6-7e8f-9012-3456789abcde",
    "firstName": "Carla",
    "lastName": "Creative",
    "hasImage": true,
    "isExternal": false
  },
  "updatedOn": "2024-01-15T09:30:00Z",
  "updatedBy": "e1f2a3b4-c5d6-7e8f-9012-3456789abcde",
  "mentions": {
    "users": [
      {
        "id": "f9e8d7c6-b5a4-3210-9fed-cba987654321",
        "firstName": "Mark",
        "lastName": "Manager",
        "hasImage": true,
        "isExternal": false
      }
    ],
    "everyUserHadPermissions": true
  },
  "reactions": [
    {
      "userId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "emoji": "👍"
    }
  ],
  "formattedMessage": "Hey team, the customer loved the latest designs!",
  "plainFormattedMessage": "Hey team, the customer loved the latest designs!",
  "resourceVersion": 637825154598057900,
  "message": "Hey team, the customer loved the latest designs!",
  "userId": "e1f2a3b4-c5d6-7e8f-9012-3456789abcde",
  "previews": [
    "https://www.awork.com/en/blog/automatic-project-management/"
  ],
  "isHiddenForConnectUsers": false,
  "isResolved": true,
  "inReplyToCommentId": "a9b8c7d6-e5f4-3210-9abc-def123456789"
}

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

Required Permissions

To create a comment the user must have at least read permissions on the specified document.

Creates a new comment on the document with the specified id. A user can only create a comment for him/herself, except for admins and api users. <Check title="Required Permissions" icon="key">To create a comment the user must have at least `read` permissions on the specified document.</Check>

Authentication

AuthorizationBearer

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

Path parameters

documentIdstringRequiredformat: "uuid"

The id of the document to create the comment for.

Request

The model to create the comment.

messagestringRequired1-65000 characters

The message of the comment.

userIdstring or nullOptionalformat: "uuid"

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

previewslist of strings or nullOptional

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.

inReplyToCommentIdstring or nullOptionalformat: "uuid"

The parent comment this comment is a reply to.

Response

idstringformat: "uuid"

The id of the comment.

entityIdstringformat: "uuid"

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

projectobject

taskobject

documentobject

createdOndatetime

The date this object was created.

createdBystringformat: "uuid"

The id of the user who created this object.

userobject

updatedOndatetime

The date this object was last modified.

updatedBystringformat: "uuid"

The id of the user who last modified this object.

mentionsobject

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.

resourceVersionlongRead-only

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.

userIdstring or nullformat: "uuid"

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

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.

inReplyToCommentIdstring or nullformat: "uuid"

The parent comment this comment is a reply to.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error