Update Task

Update task.

Scopes: Default, wsReadWrite

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Query Params
string

Title of task

string

Task Description

string
enum

Task status. Not available for the Team plan

  • Active - Active
  • Deferred - Deferred
  • Completed - Completed
  • Cancelled - Cancelled
Allowed:
string
enum

Task importance

  • High
  • Low
  • Normal
Allowed:
dates
object

Reschedule task and/or change task type

addParents
array of objects

Put task into specified folders of same account. Cannot contain RecycleBin folder

addParents
removeParents
array of strings

Remove task from specified folders. Can not contain RecycleBin folder

removeParents
addShareds
array of objects

Shared task with specified users or invitations

addShareds
removeShareds
array of strings

Unshare task from specified users or invitations

removeShareds
addResponsibles
array of strings

Add specified users or invitations to assignee list

addResponsibles
removeResponsibles
array of strings

Remove specified users or invitations from assignee list

removeResponsibles
addResponsiblePlaceholders
array of objects

Add specified placeholders to placeholder assignee list

addResponsiblePlaceholders
removeResponsiblePlaceholders
array of strings

Remove specified placeholders from placeholder assignee list

removeResponsiblePlaceholders
addFollowers
array of strings

Add specified users to task followers

addFollowers
boolean

Follow task

string

Put task in task list before specified task

string

Put task in task list after specified task

addSuperTasks
array of strings

Add the task as subtask to specified tasks

addSuperTasks
removeSuperTasks
array of strings

Remove the task form specified tasks subtasks

removeSuperTasks
metadata
array of objects
length ≤ 100

Metadata to be updated (null value removes entry). Limit : 100

metadata
customFields
array of objects
length ≤ 100

Custom fields to be updated or deleted (null value removes field). Limit : 100

customFields
string

Custom status ID

boolean

Restore task from Recycled Bin

effortAllocation
object

Set Task Effort fields: mode, total Effort

setResponsibleAllocation
array of objects

Update responsible allocations

setResponsibleAllocation
string
enum

Task's timelogs billing type

  • Billable - Billable
  • NonBillable - Non-Billable
Allowed:
boolean

Include invitations in sharedIds & responsibleIds lists

string

Custom Item Type id

boolean

Strip HTML tags from custom fields

string

Id of work schedule to assign to task

fields
array of strings

Json string array of optional fields to be included in the response model

  • billingType - Billing type
  • workScheduleId - Id of work schedule assigned to task
  • effortAllocation - Effort Allocation
  • responsiblePlaceholderIds - List of placeholder assignee IDs
fields
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json