Delete a workflow pin

DELETE/api/v2/workspaces/{slug}/work-item-types/{type_id}/governance/pins/{pk}/

Remove one pin. A successful delete returns 204 with an empty body.

Deleting a pin removes only the marker that says the workspace fixed the workflow. The project keeps the workflow the pin set, so no pick changes and no work item moves. From then on, the project can change its own pick with Update a work item type workflow, within the type's governance mode.

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.

type_id:requiredstring (uuid)

The work item type the pin belongs to.

pk:requiredstring (uuid)

The id of the pin 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: created_at, id, project_id, updated_at, work_item_type_id, workflow_id.

See Sparse fields.

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	The Workspace governance feature isn't on your plan, or is turned off.
403	forbidden	Your role or token scope can't edit workspace workflows.
404	not_found	No such pin on this work item type.
406	not_acceptable	The Accept header asks for a representation the API can't produce.
409	states_managed_at_project	The workspace doesn't have governance turned on.
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 workflow pin

curl -X DELETE \
  "https://api.plane.so/api/v2/workspaces/my-team/work-item-types/d1e7a4c9-2b58-4f36-9a0e-7c3b5d81f240/governance/pins/0b6d3f92-7e15-4a48-9c27-5f8e1a4d6b30/" \
  -H "X-Api-Key: $PLANE_API_KEY"

import requests

response = requests.delete(
    "https://api.plane.so/api/v2/workspaces/my-team/work-item-types/d1e7a4c9-2b58-4f36-9a0e-7c3b5d81f240"
    "/governance/pins/0b6d3f92-7e15-4a48-9c27-5f8e1a4d6b30/",
    headers={"X-Api-Key": "your-api-key"},
)
print(response.status_code)

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/work-item-types/d1e7a4c9-2b58-4f36-9a0e-7c3b5d81f240" +
    "/governance/pins/0b6d3f92-7e15-4a48-9c27-5f8e1a4d6b30/",
  {
    method: "DELETE",
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
console.log(response.status);

Response204

No response body.

Response409

{
  "type": "conflict",
  "code": "states_managed_at_project",
  "detail": "Work item type governance is managed at the project level in this workspace."
}