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

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

<Check title="Required Permissions" icon="key">The user must be an admin or have `workspace-manage-config:write` permissions.</Check>

AuthorizationBearer

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

typeOfWorkIdstringRequiredformat: "uuid"

The id of the type of work.

The archived form payload.

isArchivedbooleanOptional

Flags the entity as archived.

idstringformat: "uuid"

The id of the task type.

namestring or null

The name of the task type.

descriptionstring or null

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

iconstring or null

The icon associated with this task type.

isArchivedboolean

Whether the type of work has been archived.

createdOndatetime

The date this entity was created.

createdBystringformat: "uuid"

The id of the user who created this entity.

updatedOndatetime

The date this entity was last modified.

updatedBystringformat: "uuid"

The id of the user who last modified this entity.

400

Bad Request Error

404

Not Found Error

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 '{}'

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:09.100Z",
8	"createdBy": "123e4567-e89b-12d3-a456-426614174000",
9	"updatedOn": "2022-03-10T18:55:00.500Z",
10	"updatedBy": "123e4567-e89b-12d3-a456-426614174000"
11	}