Add custom property values

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

Allows you to specify the values for a custom property.

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.

property_id:requiredstring

The unique identifier for the custom property.

Body Parameters

value:requiredstring | boolean | number | string[]

The value type depends on the property type:

• TEXT/URL/EMAIL/FILE: string
• DATETIME: string (YYYY-MM-DD or YYYY-MM-DD HH:MM:SS)
• DECIMAL: number (int or float)
• BOOLEAN: boolean (true/false)
• OPTION/RELATION (single): string (UUID)
• OPTION/RELATION (multi, when is_multi=True): list of strings (UUIDs) or single string

For multi-value properties (is_multi=True):

• Accept either a single UUID string or a list of UUID strings
• Multiple records are created
• Response will be a list of values

For single-value properties:

• Only one value is allowed per work item/property combination

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_id}/values/" \
  -H "X-API-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "value": "example-value"
}'

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_id}/values/",
    headers={"X-API-Key": "your-api-key"},
    json={
  'value': 'example-value'
}
)
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_id}/values/',
  {
    method: 'POST',
    headers: {
      'X-API-Key': 'your-api-key',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      value: 'example-value',
    }),
  },
);
const data = await response.json();

Response201

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