Archives or unarchives the type of work with the specified id. — awork API

Archives or unarchives the type of work with the specified id. An archived type of work still exists for all tasks and time entries currently using it, but can no longer be created with this type of work.

Required Permissions: The user must be an admin or have workspace-manage-config:write permissions.

Path parameters

typeOfWorkIdstringRequired

Id of the type of work which will be archived.

Request

This endpoint expects an object.

isArchivedbooleanRequired

Flags the entity as archived.

Response

idstringOptional

The id of the task type.

namestringOptional

The name of the task type.

descriptionstringOptional

A short (max. 140 characters) description of the task type.

iconstringOptional

The icon associated with this task type.

isArchivedbooleanOptional

Whether the type of work has been archived.

createdOndatetimeOptional

The date this entity was created.

createdBystringOptional

The id of the user who created this entity.

updatedOndatetimeOptional

The date this entity was last modified.

updatedBystringOptional

The id of the user who last modified this entity.

1	curl -X POST https://api.awork.com/api/v1/typeofwork/typeOfWorkId/setarchived \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"isArchived": true
6	}'

1	{
2	"id": "123e4567-e89b-12d3-a456-426614174000",
3	"name": "Sales Work",
4	"description": "Tasks related to sales dept.",
5	"icon": "attach_money",
6	"isArchived": true,
7	"createdOn": "2022-03-10T16:25:09Z",
8	"createdBy": "123e4567-e89b-12d3-a456-426614174000",
9	"updatedOn": "2022-03-10T18:55:00Z",
10	"updatedBy": "123e4567-e89b-12d3-a456-426614174000"
11	}