tasks.tasks.update

Updates the properties of a task to which the user has editing access.

Parameters

  • id POST

    Task ID.

  • name POST

    Task name.

  • text POST

    Task description.

  • assigned_contact_id POST

    ID of the user to whom the task must be assigned.

  • project_id POST

    ID of the project to which the task must belong.

  • milestone_id POST

    The milestone to which the task must belong.

  • priority POST Optional

    Priority: -1 (low), 0 (normal), 1 (high), 2 (urgent), 3 (burns). If no specified then the normal priority is set: 1.

  • status_id POST

    Task status. If not specified then the status with ID = 0 is used (“New”).

  • hidden_timestamp POST

    Timestamp of sending the task to the archive. A value above zero means that a task is in the archive.

  • due_date POST

    Deadline date in the “yyyy-mm-dd” format.

  • files_hash POST

    The hash of files uploaded using the “tasks.attachments.add” method if you need to attach them to the new task.

  • attachments_to_delete POST Optional

    Array of IDs of attached files which must be deleted.

  • format GET Optional

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

Return value

Array with the following keys:

  • id int Task ID.
  • name string Task name.
  • text string Task description.
  • text_stripped string Task description without HTML tags, truncated to maximum 256 characters.
  • assigned_contact array|null Information about the user, to which the task has been assigned, with the following keys:
  • assigned_contact['id'] int User ID.
  • assigned_contact['name'] string User name.
  • assigned_contact['photo_url'] string URL of a 96x96 pixels large user image.
  • attachments array The list of files attached to the task. Each array 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 task, 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 task creation in the ISO 8601 format.
  • attachments[]['download_url'] string File 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 task 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_id int|null ID of the user who was the last to execute an action on the task.
  • create_contact array Information about the user, who has added the task, as an array with the following keys:
  • create_contact['id'] int User ID.
  • create_contact['name'] string User name.
  • create_contact['photo_url'] string URL of a 96x96 pixels large user image.
  • create_datetime string Date and time of the task adding in the ISO 8601 format.
  • due_date date|null Deadline date.
  • favorite bool Flag denoting whether the task is in the “Watching” list of the current user.
  • favorite_unread bool Flag denoting whether the task is in the “Watching” list of the current user and is marked for them as unread.
  • hidden_timestamp int|null Timestamp of the date and time of sending the task to the archive.
  • log array The list of actions in the task log. Each list item is an array with the following keys with the following keys:
  • log[]['action'] string Action performed an a task.
  • log[]['after_status_id'] int ID of the status in which the task had been before the action was executed.
  • log[]['assigned_contact'] array Information about the user, to which the task was assigned, with the following keys:
  • log[]['assigned_contact']['id'] int User ID.
  • log[]['assigned_contact']['name'] string User name.
  • log[]['assigned_contact']['is_me'] bool Flag denoting whether the action was executed by the current user.
  • log[]['assigned_contact']['photo_url'] string URL of a 96x96 pixels large user image.
  • log[]['assignment_changed'] bool Flag denoting whether the task was assigned to another user when the action was executed.
  • log[]['attachments'] array The list of files during the action execution. Each array item is an array with the following keys:
  • log[]['attachments'][]['id'] int File ID.
  • log[]['attachments'][]['code'] string Random file code.
  • log[]['attachments'][]['contact'] array The properties of the user, who executed the action, as an array with the following keys:
  • log[]['attachments'][]['contact']['id'] int User ID.
  • log[]['attachments'][]['contact']['is_me'] bool Flag denoting whether the action was executed by the current user.
  • log[]['attachments'][]['contact']['name'] string User name.
  • log[]['attachments'][]['contact']['photo_url'] string URL of a 96x96 pixels large user image.
  • log[]['attachments'][]['create_datetime'] string Date and time of the action execution in the ISO 8601 format.
  • log[]['attachments'][]['download_url'] string File URL.
  • log[]['attachments'][]['ext'] string File name extension.
  • log[]['attachments'][]['is_image'] bool Flag denoting whether the file contains an image.
  • log[]['attachments'][]['log_id'] int ID of the entry about the added comment in the user actions log.
  • log[]['attachments'][]['name'] string File name.
  • log[]['attachments'][]['preview_url'] string URL of the file’s preview image.
  • log[]['attachments'][]['size'] int File size in bytes.
  • log[]['before_status_id'] int ID of the status in which the task had been before the action execution.
  • log[]['contact'] array The properties of the user, who executed the action, with the following keys:
  • log[]['contact']['id'] int User ID.
  • log[]['contact']['name'] string User name.
  • log[]['contact']['photo_url'] string URL of a 96x96 pixels large user image.
  • log[]['create_datetime'] string Date and time of the action execution in the ISO 8601 format.
  • log[]['project_id'] int ID of the project to which the task belongs.
  • log[]['status_changed'] bool Flag denoting whether the task status was changed during the action execution.
  • log[]['task_id'] int Task ID.
  • log[]['task_name'] string Task name.
  • log[]['task_number'] string Task’s number within its project.
  • log[]['text'] string Text entered by a user during the action execution.
  • log[]['text_stripped'] string Entered text without HTML tags, truncated to maximum 256 characters.
  • data[]['milestone_id'] int|null Milestone ID.
  • data[]['next_status_id'] int ID of the next status according to the settings of the project to which the task belongs.
  • data[]['number'] int Task’s number within its project.
  • data[]['priority'] int Task priority.
  • project array Information about the project, to which the task belongs, as an array with the following keys:
  • project['id'] int Project ID.
  • project['name'] string Project name.
  • project['archive_datetime'] string|null Date and time of sending the project to the archive in the ISO 8601 format.
  • project['color'] string Color name to highlight tasks.
  • project['contact'] array The properties of the user who has created the project as an array with the following keys:
  • project['contact']['id'] int User ID.
  • project['contact']['is_me'] bool Flag denoting that the project has been created by the current user.
  • project['contact']['name'] string User name.
  • project['contact']['photo_url'] string URL of a 96x96 pixels large user image.
  • project['counts'] array Array of task counters for this project with the following keys:
  • project['counts']['active'] int Number of active tasks.
  • project['counts']['active_priority'] int Number of active tasks with a high priority.
  • project['counts']['closed'] int Number of closed tasks.
  • project['counts']['total'] int Total number of tasks.
  • project['create_datetime'] string Project creation data and time in the ISO 8601 format.
  • project['icon'] string Logo URL.
  • project['sort'] int Sort value.
  • project_id int Project ID.
  • publicLinks array The list of URLs of public links to the task.
  • return_status_id int ID of the previous task status according to the task project settings.
  • status_id int Status ID.
  • tags array The list of tags linked to the task. Each list item is an array with the following keys with the following keys:
  • tags[]['id'] int Tag ID.
  • tags[]['name'] string Tag name.
  • update_datetime string Date and time of the latest task update.
  • uuid string Unique task identifier.