Skip to content

Delete a workspace work item property ​

DELETE/api/v2/workspaces/{slug}/work-item-properties/{pk}/

Remove a property from the workspace catalog. The delete is soft and the response is 204 with an empty body.

This is the wide blast radius option: the property leaves every project and work item type it reached, unlike detaching it from a single type, which only affects that one type.

Retire before you delete

If the property has been collecting values, PATCH it with is_active: false first. The definition stays addressable while you migrate, and you can reverse the decision with a single field. Deleting is the move for a property created by mistake.

Wrong mode is a 409, not a 404

If the workspace manages work item types at the project level, this route returns 409 with the code work_item_types_managed_at_project. Delete the property on the project-level resource instead. See Work item type modes.

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 property's id.

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: created_at, default_value, description, display_name, external_id, external_source, id, is_active, is_multi, is_required, logo_props, name, options, property_type, relation_type, settings, validation_rules.

See Sparse fields.

Scopes ​

workspaces.work_item_properties:write

Errors ​

StatusCodeCause
400invalid_requestThe request failed validation — most often a pk that isn't a valid UUID.
401unauthorizedMissing or invalid credentials.
402payment_requiredThe feature this endpoint belongs to isn't enabled on your plan, or is switched off.
403forbiddenYour role or token scope can't write workspace work item properties.
404not_foundNo such workspace or property, or it's outside your tenant.
406not_acceptableThe Accept header asks for a representation the API can't produce.
409conflictThis workspace manages work item types at the project level.
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 workspace property
bash
curl -X DELETE \
  "https://api.plane.so/api/v2/workspaces/my-team/work-item-properties/a7e3f1d0-5c92-4b68-8f31-2d4a6b9e0c15/" \
  -H "X-Api-Key: $PLANE_API_KEY"
Response204
text
No content
Response409
json
{
  "type": "conflict",
  "code": "work_item_types_managed_at_project",
  "detail": "This workspace manages work item types at the project level. Use the project-level endpoint instead."
}

Deleting the property takes its scoping with it

A property's contexts and options are mounted underneath it. Once the property is gone, those sub-resources are no longer addressable — GETs under the deleted property_id return 404 not_found.