tasks

Updates multiple tasks with the selected operation.

Changed on

Updates multiple tasks with the selected operation. Supported operations move tasks, change dates, manage tags, change status or type, assign users, copy tasks, and delete tasks. <Check title="Required Permissions" icon="key">The user must have write permission for the requested tasks and related entities.</Check>

post/tasks/batch/{operation}

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/tasks/batch/{operation}
  • Auth: HTTP bearer

Path parameters

operationstring required

The operation to perform on all tasks.

Request body

taskIdsstring[] required

The list of task ids to perform the batch operation on.

newTaskListIdstring uuid nullable

The id of the new task list. Needed if operation is 'movetotasklist'. Optional if operation is 'movetoproject'.

removeFromCurrentListboolean nullable

Whether to remove the task from all its current task lists. Optional for operation 'movetotasklist'.

newProjectIdstring uuid nullable

The id of the new project to move the tasks to. Needed if operation is 'movetoproject'.

newParentTaskIdstring uuid nullable

The id of the task that will be the new parent of the selected tasks. Needed if operation is 'moveundertask'.

newTaskStatusIdstring uuid nullable

Deprecated for 'movetoproject': use TaskStatusMapping instead. The id of the new task status id to change the tasks to. Needed if operation is 'movetoproject' or 'changetaskstatus'.

newDueDatestring date-time nullable

The new due date for the tasks. Optional for operation 'setdates'. If not set, due and start date will be removed.

newStartDatestring date-time nullable

The new start date for the tasks. Optional for operation 'setdates'. Only gets used when NewDueDate is set.

removeDueDateboolean nullable

Whether to remove the due date. Required for operation 'setdates'.

removeStartDateboolean nullable

Whether to remove the start date. Required for operation 'setdates'.

deleteTimeTrackingsboolean nullable

Whether to delete the timetrackings of each task when deleting tasks. Optional for operation 'delete'.

newTypeOfWorkIdstring uuid nullable

The new type of work id for the tasks. Required if operation is 'changetypeofwork'.

changeTimeEntriesboolean nullable

Whether to change the type of work of the timeentries for each task aswell. Optional for operation 'changetypeofwork'.

userIdsstring[] nullable

Depending on the batch operation, it can be either the ids of the user to assign ('assignusers', required) or the ids of the user to remove ('unassignusers', optional, if not provided unassigns all users).

removeOldAssignmentsboolean nullable

Whether to replace or add user assignments to a task that has users already assigned. Optional for operation 'assignusers'.

isPrioboolean nullable

Whether to set the tasks to be prio or not. Required for operation 'setprio'.

daysOffsetnumber double nullable

In case of an adjust date operation, define the number (positive or negative) of days that will be added/subtracted to the task dates. It can be a decimal number (fraction of day)

adjustSuccessorsboolean nullable

If set to true, it will adjust the dates of successor tasks as well.

adjustSubtasksboolean nullable

If set to true, it will adjust the dates of subtasks of selected tasks. If set to false, it will only adjust the dates of the selected tasks.

Response

Multi-Status

Changes

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e46cf415581Revision changes
    • info

      api operation id PostTasksBatchByOperation removed and replaced with tasks_PostTasksBatchByOperation