workflows

Deletes a project status from the workflow.

Changed on

Deletes a project status from the workflow. A workflow must always have at least one project status to ensure projects using this workflow have a valid status. If you attempt to delete the last remaining project status, this endpoint will return a BadRequest error. If any projects are currently using this status, you must provide a NewProjectStatusId in the request body to migrate those projects 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}/projectstatuses/{projectStatusId}/delete

Request

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

Path parameters

workflowIdstring uuid required

The Id of the workflow.

projectStatusIdstring uuid required

The Id of the project status to delete.

Request body

newProjectStatusIdstring uuid nullable

The Id of the project status to migrate projects to. Required if any projects 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 PostWorkflowProjectStatusDeleteByWorkflowIdAndProjectStatusId removed and replaced with workflows_PostWorkflowProjectStatusDeleteByWorkflowIdAndProjectStatusId