Archives or unarchives the task list with the specified id.

POST

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

Path parameters

projectIdstringRequired

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

taskListIdstringRequired

Id of the task list which will be archived.

Request

This endpoint expects an object.
isArchivedbooleanRequired

Flags the entity as archived.

taskOperationstringOptional

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.

taskListIdstringOptional

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

deleteTimeTrackingsbooleanOptionalDefaults to false

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

idstringOptional

The id of the task list.

isArchivedbooleanOptionalDefaults to false

Whether the task list has been archived.

createdOndatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

The date this task list was created.

createdBystringOptional

The id of the user who created this task list.

updatedOndatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

The date this task list was last modified.

updatedBystringOptional

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

namestringOptional

The name of the list.

orderdoubleOptional

The order of the list.

isHiddenForConnectUsersbooleanOptionalDefaults to false

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

Built with