v1

latestOpenAPI 3.0.12026-07-24241275527.9 KB

Tasks

Update Task

Update task.

<b>Scopes:</b> Default, wsReadWrite

put/tasks/{taskId}

Path parameters

taskIdstring required

Query parameters

titlestring

Title of task

descriptionstring

Task Description

status'Active' | 'Deferred' | 'Completed' | 'Cancelled'

Active - Active
Deferred - Deferred
Completed - Completed
Cancelled - Cancelled

Task status. Not available for the Team plan

Active - Active
Deferred - Deferred
Completed - Completed
Cancelled - Cancelled

importance'High' | 'Low' | 'Normal'

High
Low
Normal

Task importance

High
Low
Normal

Reschedule task and/or change task type

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

Remove task from specified folders. Can not contain RecycleBin folder

Shared task with specified users or invitations

Unshare task from specified users or invitations

Add specified users or invitations to assignee list

Remove specified users or invitations from assignee list

Add specified placeholders to placeholder assignee list

Remove specified placeholders from placeholder assignee list

Add specified users to task followers

followboolean

Follow task

priorityBeforestring

Put task in task list before specified task

priorityAfterstring

Put task in task list after specified task

Add the task as subtask to specified tasks

Remove the task form specified tasks subtasks

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

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

customStatusstring

Custom status ID

restoreboolean

Restore task from Recycled Bin

Set Task Effort fields: mode, total Effort

Update responsible allocations

billingType'Billable' | 'NonBillable'

Billable - Billable
NonBillable - Non-Billable

Task's timelogs billing type

Billable - Billable
NonBillable - Non-Billable

withInvitationsboolean

Include invitations in sharedIds & responsibleIds lists

convertToCustomItemTypestring

Custom Item Type id

plainTextCustomFieldsboolean

Strip HTML tags from custom fields

workScheduleIdstring

Id of work schedule to assign to task

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

Response

success response