Add custom property values

POST/api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/work-item-properties/{property_id}/values/

Create or update the property value for a work item. This is an upsert, because a work item can have only one value per property.

Path parameters

project_id:requiredstring

The unique identifier of the project.

property_id:requiredstring

The unique identifier of the property.

workspace_slug:requiredstring

The workspace slug. It appears in your Plane URLs. In https://app.plane.so/my-team/projects/, the slug is my-team.

work_item_id:requiredstring

The unique identifier of the work item.

Body parameters

value:requiredobject

The value to set for the property. Its type depends on the property type: a string for text, URL, email, and file fields; a UUID string, or a list of UUIDs when is_multi is true, for relations and options; a YYYY-MM-DD string for dates; a number for decimals; and a boolean for booleans.

external_id:optionalstring

Optional external identifier, for syncing with external systems.

external_source:optionalstring

Optional name of the external source, for example github or jira.

Scopes

projects.work_item_property_values:write

Add custom property values

curl -X POST \
  "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/work-item-properties/property-uuid/values/" \
  -H "X-API-Key: $PLANE_API_KEY" \
  # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "value": "example text value",
  "external_id": "550e8400-e29b-41d4-a716-446655440000",
  "external_source": "github"
}'

import requests

response = requests.post(
    "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/work-item-properties/property-uuid/values/",
    headers={"X-API-Key": "your-api-key"},
    json={
      "value": "example text value",
      "external_id": "550e8400-e29b-41d4-a716-446655440000",
      "external_source": "github"
    }
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/work-item-properties/property-uuid/values/",
  {
    method: "POST",
    headers: {
      "X-API-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      value: "example text value",
      external_id: "550e8400-e29b-41d4-a716-446655440000",
      external_source: "github",
    }),
  },
);
const data = await response.json();

Response200

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "property_id": "550e8400-e29b-41d4-a716-446655440000",
  "issue_id": "550e8400-e29b-41d4-a716-446655440000",
  "value": "Example Name",
  "value_type": "Example Name",
  "external_id": "550e8400-e29b-41d4-a716-446655440000",
  "external_source": "github",
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}