add-property.mdx

title	Create a custom property
description	Creates a new custom property for a work item type.
api	POST /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-item-types/{type_id}/work-item-properties/

Path parameters

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`. The unique identifier of the project.

The unique identifier for the work item type.

Body parameters

Display name shown in the UI. Description of the custom property. Type of the property. Possible values: TEXT, DATETIME, DECIMAL, BOOLEAN, OPTION, RELATION. Relation type if the property links to other entities. Possible values: null, USER. Default value(s) for the property. Validation rules applied to property values. Whether this property is required when creating work items. Whether this property is currently active. Whether this property allows multiple values. Array of option objects for OPTION type properties. This field can be used while creating a property with type OPTION to set options on the custom property during creation itself. Each option object can contain:

• name (string): Name of the option
• description (string): Description of the option
• is_active (boolean): Whether the option is active
• sort_order (number): Sort order for the option
• parent (string): Parent option ID for hierarchical options
• is_default (boolean): Whether this is the default option
• logo_props (object): Logo properties for the option

To add or update options on an OPTION property after creation, you can use the APIs from issue-types/options/add-dropdown-options.