Sets the archived status of a workflow. | awork API

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

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

AuthorizationBearer

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

workflowIdstringRequiredformat: "uuid"

This endpoint expects an object.

isArchivedbooleanOptional

Flags the entity as archived.

idstringformat: "uuid"

The id of the entity.

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.

namestring or null

The name of the entity.

iconstring or null

The icon associated with this workflow.

isArchivedboolean

Whether the workflow has been archived.

isExternalboolean

True if the workflow is coming from an external workspace (awork Connect). False otherwise.

400

Bad Request Error

404

Not Found Error

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

1	{
2	"id": "123e4567-e89b-12d3-a456-426614174000",
3	"createdOn": "2022-03-11T15:33:47.100Z",
4	"createdBy": "123e4567-e89b-12d3-a456-426614174000",
5	"updatedOn": "2022-03-11T21:15:00.100Z",
6	"updatedBy": "123e4567-e89b-12d3-a456-426614174000",
7	"name": "Website Design and Implementation",
8	"icon": "workflow",
9	"isArchived": true,
10	"isExternal": true
11	}