Deletes a workflow. | awork API

curl -X POST https://api.awork.com/api/v1/workflows/workflowId/delete \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "deleteOperation": "migrate",
  "newWorkflowId": "9f8b7c6d-1234-4a56-b789-0cdef1234567",
  "projectStatusMapping": [
    {
      "oldProjectStatusId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "newProjectStatusId": "b2c3d4e5-f678-90ab-cdef-234567890abc"
    },
    {
      "oldProjectStatusId": "c3d4e5f6-7890-abcd-ef12-34567890abcd",
      "newProjectStatusId": "d4e5f678-90ab-cdef-1234-567890abcdef"
    }
  ],
  "taskStatusMapping": [
    {
      "oldTaskStatusId": "e5f67890-abcd-ef12-3456-7890abcdef12",
      "newTaskStatusId": "f67890ab-cdef-1234-5678-90abcdef1234"
    },
    {
      "oldTaskStatusId": "7890abcd-ef12-3456-7890-abcdef123456",
      "newTaskStatusId": "890abcde-f123-4567-890a-bcdef1234567"
    }
  ],
  "keepCustomFields": true,
  "keepCustomAutomations": false
}'

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.

Required Permissions

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

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>

Authentication

AuthorizationBearer

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

Path parameters

workflowIdstringRequiredformat: "uuid"

Request

This endpoint expects an object.

deleteOperationstring or nullOptional

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

newWorkflowIdstring or nullOptionalformat: "uuid"

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

projectStatusMappinglist of objects or nullOptional

Maps source workflow project statuses to target workflow project statuses during migration.

taskStatusMappinglist of objects or nullOptional

Maps source workflow task statuses to target workflow task statuses during migration.

keepCustomFieldsboolean or nullOptional

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

keepCustomAutomationsboolean or nullOptional

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

Response

No Content

Errors

400

Bad Request Error

404

Not Found Error