Skip to content

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:

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. Fields you don't request are left out of the response instead of coming back as null, so a missing key means you didn't ask for it and null means the value is null. id is always included, whether or not you name it.

Pass all to get every requestable field. An unknown field name returns 400 with the list of valid names and the closest match, so a typo is caught instead of being silently ignored.

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 ​

StatusCodeCause
400invalid_requestThe request body or a query parameter failed validation.
401unauthorizedMissing or invalid credentials.
402payment_requiredProject states aren't included in the workspace's plan, or are turned off in its settings.
403forbiddenYour role or token scope can't delete project states.
404not_foundNo such project state or workspace, or it's outside your tenant.
406not_acceptableThe Accept header asks for a representation the API can't produce.
409conflictThe project state is the default, or projects are still in it.
409governance_migration_in_progressA governance migration is running, so the workspace is read-only. Retry after it finishes.
413payload_too_largeThe request body is over the size limit.
415unsupported_media_typeThe Content-Type isn't one this endpoint accepts.
429rate_limitedThrottled. Honor the Retry-After header before retrying.
Delete a project state
bash
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"
Response204

No response body.

Response409
json
{
  "type": "conflict",
  "code": "conflict",
  "detail": "The default project state cannot be deleted."
}
Response409
json
{
  "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 Plane keeps the row. There is no restore operation, so treat the 204 as final.