Update work item with properties

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

Update a work item's standard fields and/or custom properties.

Accepts both standard issue fields and custom property fields:

• Standard fields: name, priority, state_id, assignee_ids, label_ids, etc.
• Custom fields: custom_field_<name> with value or {"value": ...} format

For OPTION type custom fields, you can pass either:

• The option UUID
• The option name (case-insensitive)

Custom properties can only be updated if the ISSUE_TYPES feature is enabled.

Path Parameters

issue_id:requiredstring

Issue ID

pk:requiredstring

Pk.

project_id:requiredstring

Project ID

slug:requiredstring

Workspace slug

Scopes

projects.work_items:write

Update work item with properties

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/properties/" \
  -H "X-API-Key: $PLANE_API_KEY"

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/properties/",
    headers={"X-API-Key": "your-api-key"}
)
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/properties/",
  {
    method: "PATCH",
    headers: {
      "X-API-Key": "your-api-key",
    },
  }
);
const data = await response.json();

Response200

{
  "name": "Example Name",
  "priority": "high"
}