Skip to content

Delete a workspace property option

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

Remove a choice from a workspace-level OPTION property. The delete is soft — the option stops being selectable and disappears from reads, and the request returns 204 with an empty body.

Deleting an option is not the same as renaming it. If the choice is being reworded, PATCH it instead: Update a workspace property option keeps the option's id, so work items already holding it keep their value.

Workspace mode only

This write requires the workspace to manage work item types at the workspace level. In project mode it returns 409 work_item_types_managed_at_project — delete the option through the project-level endpoint 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.

property_id:requiredstring (uuid)

The workspace-level property the option belongs to. See Workspace work item properties.

pk:requiredstring (uuid)

The option to delete. It is looked up within the property, so an option id under the wrong property_id is a 404.

Deleting the property's default option leaves the property with no default. Nothing promotes another option in its place — set a new default explicitly if the property needs one.

Scopes

workspaces.work_item_properties:write

Errors

StatusCodeCause
401unauthorizedMissing or invalid credentials.
403forbiddenYour role or token scope can't write this workspace's properties.
404resource_not_foundNo such workspace, workspace-level property, or option — or it's outside your tenant. Already-deleted options are 404 too.
409work_item_types_managed_at_projectThis workspace manages work item types at the project level. Use the project-level options endpoint.
429rate_limitedThrottled. Honor the Retry-After header before retrying.
Delete a property option
bash
curl -X DELETE \
  "https://api.plane.so/api/v2/workspaces/my-team/work-item-properties/9d0e1f3b-6a72-4c85-9e4d-2b7f1a6c8d54/options/2f6a94c1-7b38-4d50-91ae-3c0d5e8b7a26/" \
  -H "X-Api-Key: $PLANE_API_KEY"
Response204
text
(empty body)
Response409
json
{
  "type": "https://api.plane.so/errors/work_item_types_managed_at_project",
  "title": "Work Item Types Managed At Project",
  "status": 409,
  "code": "work_item_types_managed_at_project",
  "detail": "Work item types are managed at the project level for this workspace."
}

Work items that already hold the option

The delete cascades: property values pointing at this option are soft-deleted with it, so work items that carried the choice lose it. That cascade runs in the background, so a read taken immediately after the 204 can still show the old value for a moment.

If you are rewording a choice rather than retiring it, update the option instead — a rename keeps the id and every work item keeps its value.