Update a work item

PATCH/api/v1/workspaces/{slug}/projects/{project_id}/work-items/{pk}/

Partially update an existing work item with the provided fields. Supports external ID validation to prevent conflicts.

Path Parameters

pk:requiredstring

Pk.

project_id:requiredstring

Project ID

slug:requiredstring

Workspace slug

Body Parameters

assignees:optionalarray

Assignees.

labels:optionalarray

Labels.

type_id:optionalstring

Type id.

parent:optionalstring

Parent.

deleted_at:optionalstring

Deleted at.

point:optionalinteger

Point.

name:optionalstring

Name.

description_html:optionalstring

Description html.

description_stripped:optionalstring

Description stripped.

priority:optionalstring

• urgent - Urgent
• high - High
• medium - Medium
• low - Low
• none - None

start_date:optionalstring

Start date.

target_date:optionalstring

Target date.

sequence_id:optionalinteger

Sequence id.

sort_order:optionalnumber

Sort order.

completed_at:optionalstring

Completed at.

archived_at:optionalstring

Archived at.

last_activity_at:optionalstring

Last activity at.

is_draft:optionalboolean

Is draft.

external_source:optionalstring

External source.

external_id:optionalstring

External id.

created_by:optionalstring

Created by.

state:optionalstring

State.

estimate_point:optionalstring

Estimate point.

type:optionalstring

Type.

Scopes

projects.work_items:write

Update a work item

curl -X PATCH \
  "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440000/" \
  -H "X-API-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Example Name",
  "description": "Example description",
  "priority": "medium",
  "state": "550e8400-e29b-41d4-a716-446655440000",
  "assignees": [
    "550e8400-e29b-41d4-a716-446655440000"
  ],
  "labels": [
    "550e8400-e29b-41d4-a716-446655440000"
  ]
}'

import requests

response = requests.patch(
    "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440000/",
    headers={"X-API-Key": "your-api-key"},
    json={
      "name": "Example Name",
      "description": "Example description",
      "priority": "medium",
      "state": "550e8400-e29b-41d4-a716-446655440000",
      "assignees": [
"550e8400-e29b-41d4-a716-446655440000"
      ],
      "labels": [
"550e8400-e29b-41d4-a716-446655440000"
      ]
    }
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440000/",
  {
    method: "PATCH",
    headers: {
      "X-API-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      name: "Example Name",
      description: "Example description",
      priority: "medium",
      state: "550e8400-e29b-41d4-a716-446655440000",
      assignees: ["550e8400-e29b-41d4-a716-446655440000"],
      labels: ["550e8400-e29b-41d4-a716-446655440000"],
    }),
  }
);
const data = await response.json();

Response200

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Example Name",
  "description": "Example description",
  "sequence_id": 1,
  "priority": "high",
  "assignees": ["550e8400-e29b-41d4-a716-446655440000"],
  "labels": ["550e8400-e29b-41d4-a716-446655440000"],
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}