---
title: "Sets the archived status of a workflow."
method: POST
path: "/workflows/{workflowId}/setarchived"
tags: ["workflows"]
---

# Sets the archived status of a workflow.

`POST /workflows/{workflowId}/setarchived`

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

## Path parameters

- `workflowId` string, uuid, required

## Headers

- `Authorization` string, required

## Request body

- ArchivedForm
  - `isArchived` boolean — Flags the entity as archived.

## Response `200`

OK

- Workflow — The workflow model.
  - `id` string, uuid — The id of the entity.
  - `createdOn` string, date-time — The date this entity was created.
  - `createdBy` string, uuid — The id of the user who created this entity.
  - `updatedOn` string, date-time — The date this entity was last modified.
  - `updatedBy` string, uuid — The id of the user who last modified this entity.
  - `name` string, nullable — The name of the entity.
  - `icon` string, nullable — The icon associated with this workflow.
  - `isArchived` boolean — Whether the workflow has been archived.
  - `isExternal` boolean — True if the workflow is coming from an external workspace (awork Connect). False otherwise.

## Other responses

- `400` — Bad Request
- `404` — Not Found

---

[API](https://skmtc.net/awork-io/apis/api-v1-reference.md) · [All operations](https://skmtc.net/awork-io/apis/api-v1-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/awork-io/api-v1-reference/versions/f784a53f60df/schema)