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

curl -X POST https://api.awork.com/api/v1/tasks/taskId/comments \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "message": "Hey team, the customer loved the latest designs!"
}'

{
  "id": "a3f1c9d2-4b7e-4f8a-9c2d-1e2f3a4b5c6d",
  "entityId": "b4d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
  "entityType": "tasks",
  "entity": {
    "id": "b4d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
    "name": "Website Redesign Task"
  },
  "project": {
    "id": "c5e3f4a5-6b7c-8d9e-0f1a-2b3c4d5e6f7a",
    "name": "Website Redesign Project"
  },
  "task": {
    "id": "b4d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
    "name": "Create Landing Page Mockups"
  },
  "document": {
    "id": "d6f4a5b6-7c8d-9e0f-1a2b-3c4d5e6f7a8b",
    "name": "Landing Page Design Specs"
  },
  "createdOn": "2024-01-15T09:30:00Z",
  "createdBy": "e7a5b6c7-8d9e-0f1a-2b3c-4d5e6f7a8b9c",
  "user": {
    "id": "e7a5b6c7-8d9e-0f1a-2b3c-4d5e6f7a8b9c",
    "firstName": "Carla",
    "lastName": "Creative",
    "hasImage": true,
    "isExternal": false
  },
  "agentId": "f8b6c7d8-9e0f-1a2b-3c4d-5e6f7a8b9c0d",
  "agentNameSnapshot": "DesignBot",
  "updatedOn": "2024-01-15T09:30:00Z",
  "updatedBy": "e7a5b6c7-8d9e-0f1a-2b3c-4d5e6f7a8b9c",
  "mentions": {
    "users": [
      {
        "id": "e7a5b6c7-8d9e-0f1a-2b3c-4d5e6f7a8b9c",
        "firstName": "Carla",
        "lastName": "Creative",
        "hasImage": true,
        "isExternal": false
      }
    ],
    "agentIds": [
      "f8b6c7d8-9e0f-1a2b-3c4d-5e6f7a8b9c0d"
    ],
    "everyUserHadPermissions": true
  },
  "reactions": [
    {
      "userId": "e7a5b6c7-8d9e-0f1a-2b3c-4d5e6f7a8b9c",
      "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": "e7a5b6c7-8d9e-0f1a-2b3c-4d5e6f7a8b9c",
  "previews": [
    "https://www.awork.com/en/blog/automatic-project-management/"
  ],
  "isHiddenForConnectUsers": false,
  "isResolved": true,
  "inReplyToCommentId": "a3f1c9d2-4b7e-4f8a-9c2d-1e2f3a4b5c6d"
}

Creates a new comment on the task 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 task.

Creates a new comment on the task 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 task.</Check>

Authentication

AuthorizationBearer

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

Path parameters

taskIdstringRequiredformat: "uuid"

The id of the task 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

idstringOptionalformat: "uuid"

The id of the comment.

entityIdstringOptionalformat: "uuid"

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

createdOnstringOptionalformat: "date-time"

The date this object was created.

createdBystringOptionalformat: "uuid"

The id of the user who created this object.

userobjectOptional

agentIdstring or nullOptionalformat: "uuid"

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

agentNameSnapshotstring or nullOptional

The agent name captured when the comment was created.

updatedOnstringOptionalformat: "date-time"

The date this object was last modified.

updatedBystringOptionalformat: "uuid"

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 objects or nullOptional

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.

resourceVersionlongOptionalRead-only

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

messagestring or nullOptional

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.

isHiddenForConnectUsersbooleanOptional

True if the comment should be hidden to 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.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error