workflows

Sets the archived status of a workflow.

Changed on

Sets the archived status of a workflow. Archived workflows remain available for existing links.

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

post/workflows/{workflowId}/setarchived

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/workflows/{workflowId}/setarchived
  • Auth: HTTP bearer

Path parameters

workflowIdstring uuid required

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.

Changes

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e46cf415581Revision changes
    • info

      api operation id PostWorkflowSetArchivedByWorkflowId removed and replaced with workflows_PostWorkflowSetArchivedByWorkflowId