Update a work item

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

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

Update a work item

cURL

curl --request PATCH \
  --url https://api.plane.so/api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description_html": "<string>",
  "state": "<string>",
  "priority": "<string>",
  "assignees": [
    "<string>"
  ],
  "labels": [
    "<string>"
  ],
  "parent": "<string>",
  "estimate_point": "<string>",
  "type": "<string>",
  "module": "<string>",
  "start_date": "<string>",
  "target_date": "<string>"
}
'

Path parameters

workspace_slug · string · required

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 · string · required

The unique identifier of the project.

work_item_id · string · required

The unique identifier for the work item.

Body parameters

name · string

Name of the work item.

description_html · string

HTML-formatted description of the work item.

state · string

ID of the state for the work item.

priority · string

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

assignees · string[]

Array of user IDs to assign to the work item.

labels · string[]

Array of label IDs to apply to the work item.

parent · string

ID of the parent work item.

estimate_point · string

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

type · string

ID of the work item type.

module · string

ID of the module the work item belongs to.

start_date · string

Start date in YYYY-MM-DD format.

target_date · string

Target completion date in YYYY-MM-DD format.