createComment
Add comments to resources like tasks, milestones, or files in Teamwork projects. Specify content, privacy, notifications, and attachments to streamline communication within projects.
Instructions
Creates a new comment for a specific resource (tasks, milestones, notebooks, links, fileversions) in Teamwork
Input Schema
Name | Required | Description | Default |
---|---|---|---|
authorId | No | ID of the user to post as (only for admins) | |
body | Yes | The content of the comment | |
contentType | No | Content type of the comment (html or plain text) | plaintext |
isPrivate | No | Whether the comment should be private | |
notify | No | Who to notify ('all' to notify all project users, 'true' to notify followers, specific user IDs, or empty for no notification) | |
pendingFileAttachments | No | Comma-separated list of pending file references to attach to the comment | |
resource | Yes | The resource type (tasks, milestones, notebooks, links, fileversions) | |
resourceId | Yes | The ID of the resource to add a comment to |
Input Schema (JSON Schema)
{
"properties": {
"authorId": {
"description": "ID of the user to post as (only for admins)",
"type": "string"
},
"body": {
"description": "The content of the comment",
"type": "string"
},
"contentType": {
"default": "plaintext",
"description": "Content type of the comment (html or plain text)",
"enum": [
"html",
"plaintext"
],
"type": "string"
},
"isPrivate": {
"default": false,
"description": "Whether the comment should be private",
"type": "boolean"
},
"notify": {
"default": "",
"description": "Who to notify ('all' to notify all project users, 'true' to notify followers, specific user IDs, or empty for no notification)",
"type": "string"
},
"pendingFileAttachments": {
"description": "Comma-separated list of pending file references to attach to the comment",
"type": "string"
},
"resource": {
"description": "The resource type (tasks, milestones, notebooks, links, fileversions)",
"enum": [
"tasks",
"milestones",
"notebooks",
"links",
"fileversions"
],
"type": "string"
},
"resourceId": {
"description": "The ID of the resource to add a comment to",
"type": "string"
}
},
"required": [
"resource",
"resourceId",
"body"
],
"type": "object"
}