workflows

Deletes a workflow.

Changed on

Deletes a workflow. If the workflow is linked to projects or project templates they can either be unlinked or migrated to another workflow before the workflow is deleted.

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

post/workflows/{workflowId}/delete

Request

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

Path parameters

workflowIdstring uuid required

Request body

deleteOperationstring nullable

Defines how linked projects and project templates should be handled before deletion. Supported values are 'unlink' and 'migrate'.

newWorkflowIdstring uuid nullable

The workflow to migrate linked projects and project templates to. Required when DeleteOperation is 'migrate'.

keepCustomFieldsboolean nullable

Whether to keep existing non-workflow custom fields when migrating. Default: true.

keepCustomAutomationsboolean nullable

Whether to keep existing non-workflow automations when migrating. Default: true.

Response

No Content

object required

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 PostWorkflowDeleteByWorkflowId removed and replaced with workflows_PostWorkflowDeleteByWorkflowId