API v1 ReferenceTask Lists

Archives or unarchives the task list with the specified id.

Archives or unarchives the task list with the specified id. An archived task list still exists but is not editable anymore.

Path parameters

projectIdUUIDRequired

The id of the project the task list is related to.

taskListIdUUIDRequired

Id of the task list which will be archived.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
isArchivedbooleanRequired

Flags the entity as archived.

taskOperationstring or nullOptional

The operation for tasks which are not yet done. The operation is required if you set a list to archived. Can be: task-to-done: Set tasks to ‘Done’ or the first status of type ‘done’. task-remove: Remove tasks from this task list. task-move: Move tasks to another list. task-delete: Deletes the non done tasks.

taskListIdUUID or nullOptional

The id of the task list where all non done tasks should moved to. Only necessary if TaskOperation is set to ‘task-move’.

deleteTimeTrackingsboolean or nullOptional

Set to true to delete also the related time trackings of all non done tasks. Only necessary if TaskOperation is set to ‘task-delete’.

Response

OK

idUUIDOptional

The id of the task list.

isArchivedbooleanOptional

Whether the task list has been archived.

createdOndatetimeOptional

The date this task list was created.

createdByUUIDOptional

The id of the user who created this task list.

updatedOndatetimeOptional

The date this task list was last modified.

updatedByUUIDOptional

The id of the user who last modified this task list.

namestring or nullOptional

The name of the list.

orderdouble or nullOptional

The order of the list.

isHiddenForConnectUsersbooleanOptional

True if the task in this list will be not visible for external workspace users. False otherwise.