Delete a workspace workflow

DELETE/api/v2/workspaces/{slug}/workflows/{pk}/

Delete a catalog workflow. A successful delete returns 204 with an empty body.

Deleting needs the Multiple workflows plan feature. Without it, the request returns 402 payment_required.

The request returns 409 workflow_in_use while anything still depends on the workflow:

• It is the workspace default workflow (is_default: true). You can't delete the default.
• A project's pick points at it.
• The workspace pinned it for a project and work item type.
• A work item type lists it in its allowlist, or mandates it.

Get workspace workflow usage lists the picks and allowlist entries that reference the workflow. Move project picks with work item type workflows, and remove pins and allowlist entries with work item type governance.

Path Parameters

slug:requiredstring

The workspace slug. It appears in your Plane URLs. In https://app.plane.so/my-team/projects/, the slug is my-team.

pk:requiredstring (uuid)

The id of the catalog workflow. A project workflow's id returns 404.

Scopes

workspaces.workflows:write

Errors

Status	Code	Cause
400	invalid_request	The request body or a query parameter failed validation.
401	unauthorized	Missing or invalid credentials.
402	payment_required	Multiple workflows isn't on your plan, or is switched off.
403	forbidden	Your role or token scope can't delete workspace workflows.
404	not_found	No such workflow in this workspace's catalog, or it's outside your tenant.
406	not_acceptable	The Accept header asks for a representation the API can't produce.
409	governance_migration_in_progress	A governance migration is running in this workspace, so writes are paused. Retry after it finishes.
409	states_managed_at_project	The workspace doesn't have governance turned on. Use the project's workflows instead.
409	workflow_in_use	The workflow is the workspace default, or a project pick, a pin, or a type allowlist references it.
413	payload_too_large	The request body is over the size limit.
415	unsupported_media_type	The Content-Type isn't one this endpoint accepts.
429	rate_limited	Throttled. Honor the Retry-After header before retrying.

Delete a workspace workflow

curl -X DELETE \
  "https://api.plane.so/api/v2/workspaces/my-team/workflows/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/" \
  -H "X-Api-Key: $PLANE_API_KEY"

import requests

response = requests.delete(
    "https://api.plane.so/api/v2/workspaces/my-team/workflows/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/",
    headers={"X-Api-Key": "your-api-key"},
)
print(response.status_code)

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/workflows/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/",
  {
    method: "DELETE",
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
console.log(response.status);

Response204

No response body.

Response409

{
  "type": "conflict",
  "code": "workflow_in_use",
  "detail": "This workflow is in use by a project pick, pin, or type allowlist."
}

Response409

{
  "type": "conflict",
  "code": "workflow_in_use",
  "detail": "The workspace default workflow cannot be deleted."
}