Delete a project state

DELETE/api/v2/workspaces/{slug}/project-states/{pk}/

Remove a stage from the workspace's project state catalog. A successful delete returns 204 with an empty body.

Two conditions block the delete with 409 conflict:

• The state is the default. Mark another project state as default first with Mark a project state as default.
• Projects are still in the state. Move each project to another state by updating its state_id with Update a project, then retry.

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 project state to delete.

Response shaping

fields:optionalstring

Comma-separated list of fields to return. Unrequested keys are omitted from the response, not returned as null, so absent means "not requested" and null means "actually null". id always comes back whether or not you name it.

Pass all for every requestable field. An unknown name is a 400 that lists the valid set and suggests the closest match, so a typo can't silently cost you the saving.

Requestable here: color, created_at, created_by_id, description, external_id, external_source, group, id, is_default, name, sequence, updated_at, updated_by_id.

See Sparse fields.

Scopes

workspaces.project_states: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	Project states aren't included in the workspace's plan, or are turned off in its settings.
403	forbidden	Your role or token scope can't delete project states.
404	not_found	No such project state or workspace, or it's outside your tenant.
406	not_acceptable	The Accept header asks for a representation the API can't produce.
409	conflict	The project state is the default, or projects are still in it.
409	governance_migration_in_progress	A governance migration is running, so the workspace is read-only. Retry after it finishes.
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 project state

curl -X DELETE \
  "https://api.plane.so/api/v2/workspaces/my-team/project-states/6f0c3a85-9b2e-4d17-a8f6-3e5b1c7d9a42/" \
  -H "X-Api-Key: $PLANE_API_KEY"

import requests

response = requests.delete(
    "https://api.plane.so/api/v2/workspaces/my-team/project-states/6f0c3a85-9b2e-4d17-a8f6-3e5b1c7d9a42/",
    headers={"X-Api-Key": "your-api-key"},
)
print(response.status_code)

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/project-states/6f0c3a85-9b2e-4d17-a8f6-3e5b1c7d9a42/",
  {
    method: "DELETE",
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
console.log(response.status);

Response204

No response body.

Response409

{
  "type": "conflict",
  "code": "conflict",
  "detail": "The default project state cannot be deleted."
}

Response409

{
  "type": "conflict",
  "code": "conflict",
  "detail": "Only an empty project state (no projects) can be deleted."
}

Deletes are soft

The project state stops appearing in the API and in Plane, but the row is kept. There is no restore operation, so treat the 204 as final.