Update a work item

PATCH/api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/

Updates an existing work item by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path Parameters

workspace_slug:requiredstring

The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL https://app.plane.so/my-team/projects/, the workspace slug is my-team.

project_id:requiredstring

The unique identifier of the project.

work_item_id:requiredstring

The unique identifier for the work item.

Body Parameters

name:optionalstring

Name of the work item.

description_html:optionalstring

HTML-formatted description of the work item.

state:optionalstring

ID of the state for the work item.

priority:optionalstring

Priority level. Possible values: none, urgent, high, medium, low.

assignees:optionalstring[]

Array of user IDs to assign to the work item.

labels:optionalstring[]

Array of label IDs to apply to the work item.

parent:optionalstring

ID of the parent work item.

estimate_point:optionalstring

Estimate points for the work item (0-7).

type:optionalstring

ID of the work item type.

module:optionalstring

ID of the module the work item belongs to.

start_date:optionalstring

Start date in YYYY-MM-DD format.

target_date:optionalstring

Target completion date in YYYY-MM-DD format.

Update a work item

curl -X PATCH \
  "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/" \
  -H "X-API-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "example-name",
  "description_html": "example-description_html",
  "state": "example-state",
  "priority": "example-priority",
  "assignees": "example-assignees",
  "labels": "example-labels",
  "parent": "example-parent",
  "estimate_point": "example-estimate_point",
  "type": "example-type",
  "module": "example-module",
  "start_date": "example-start_date",
  "target_date": "example-target_date"
}'

import requests

response = requests.patch(
    "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/",
    headers={"X-API-Key": "your-api-key"},
    json={
  'name': 'example-name',
  'description_html': 'example-description_html',
  'state': 'example-state',
  'priority': 'example-priority',
  'assignees': 'example-assignees',
  'labels': 'example-labels',
  'parent': 'example-parent',
  'estimate_point': 'example-estimate_point',
  'type': 'example-type',
  'module': 'example-module',
  'start_date': 'example-start_date',
  'target_date': 'example-target_date'
}
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/",
  {
    method: "PATCH",
    headers: {
      "X-API-Key": "your-api-key",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
  "name": "example-name",
  "description_html": "example-description_html",
  "state": "example-state",
  "priority": "example-priority",
  "assignees": "example-assignees",
  "labels": "example-labels",
  "parent": "example-parent",
  "estimate_point": "example-estimate_point",
  "type": "example-type",
  "module": "example-module",
  "start_date": "example-start_date",
  "target_date": "example-target_date"
})
  }
);
const data = await response.json();

Response200

{
  "id": "project-uuid",
  "name": "Project Name",
  "identifier": "PROJ",
  "description": "Project description",
  "created_at": "2024-01-01T00:00:00Z"
}