v1

latestOpenAPI 3.1.02026-08-066984441.1 MB
workflows

Sets the archived status of a workflow.

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

post/workflows/{workflowId}/setarchived

Path parameters

workflowIdstring uuid required

Headers

Authorizationstring required

Bearer authentication

Request body

isArchivedboolean

Flags the entity as archived.

Response

OK

idstring uuid

The id of the entity.

createdOnstring date-time

The date this entity was created.

createdBystring uuid

The id of the user who created this entity.

updatedOnstring date-time

The date this entity was last modified.

updatedBystring uuid

The id of the user who last modified this entity.

namestring nullable

The name of the entity.

iconstring nullable

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.