workflows

Deletes the task status of the workflow.

Changed on

Deletes the task status of the workflow. A workflow must always have at least one task status of type 'todo' and one of type 'done'. If you attempt to delete the last status of either type, this endpoint will return a BadRequest error. If any tasks are currently using this status, you must provide a NewTaskStatusId in the request body to migrate those tasks to a different status within the same workflow.

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

post/workflows/{workflowId}/taskstatuses/{taskStatusId}/delete

Request

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

Path parameters

workflowIdstring uuid required

The Id of the workflow.

taskStatusIdstring uuid required

The Id of the task status to delete.

Request body

newTaskStatusIdstring uuid nullable

The Id of the task status to migrate tasks to. Required if any tasks are currently using the status being deleted. Must be a different status within the same workflow.

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 PostWorkflowTaskStatusDeleteByWorkflowIdAndTaskStatusId removed and replaced with workflows_PostWorkflowTaskStatusDeleteByWorkflowIdAndTaskStatusId