Apps » Teamwork »

tasks.comments.add

Adds a comment to a task.

HTTP method

POST

Content type

application/x-www-form-urlencoded

Parameters

  • task_id POST
    Task ID.
  • text POST
    Comment contents.
  • files_hash POST Optional
    The hash of files uploaded using the tasks.attachments.add method if you need to attach them to the new comment.
  • format GET Optional

    Sets response format. Available options: json (default), xml.

Return value

Array with the following keys:

  • action string Action identifier: 'comment'.
  • attachments array The list of files attached to the added comment. Each list item is an array with the following keys:
  • attachments[]['id'] int File ID.
  • attachments[]['code'] string Random file code.
  • attachments[]['contact'] array The properties of the user, who has added the comment, as an array with the following keys:
  • attachments[]['contact']['id'] int User ID.
  • attachments[]['contact']['name'] string User name.
  • attachments[]['contact']['photo_url'] string URL of a 96x96 pixels large user image.
  • attachments[]['create_datetime'] string Date and time of the comment adding, in the ISO 8601 format.
  • attachments[]['download_url'] string File download URL.
  • attachments[]['ext'] string File name extension.
  • attachments[]['is_image'] bool Flag denoting whether the file contains an image.
  • attachments[]['log_id'] int ID of the entry about the added comment in the user actions log.
  • attachments[]['name'] string File name.
  • attachments[]['preview_url'] string URL of the file’s preview image.
  • attachments[]['size'] int File size in bytes.
  • contact array The properties of the user, who has added the comment, as an array with the following keys:
  • contact['id'] int User ID.
  • contact['name'] string User name.
  • contact['photo_url'] string URL of a 96x96 pixels large user image.
  • create_datetime string Date and time of the comment adding, in the ISO 8601 format.
  • task_id int Task ID.
  • text string Comment text.
  • text_stripped string Comment text without HTML tags, truncated to maximum 256 characters.