Skip to main content
POST
/
api
/
v1
/
workspaces
/
{workspace_slug}
/
customer-properties
/
Create a customer property
curl --request POST \
  --url https://api.plane.so/api/v1/workspaces/{workspace_slug}/customer-properties/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "name": "<string>",
  "display_name": "<string>",
  "description": "<string>",
  "property_type": "<string>",
  "relation_type": "<string>",
  "is_required": true,
  "is_multi": true,
  "is_active": true,
  "sort_order": 123,
  "default_value": [
    "<string>"
  ],
  "settings": {},
  "validation_rules": {},
  "logo_props": {},
  "external_source": "<string>",
  "external_id": "<string>"
}'

​
Path parameters

​
workspace_slug
string
required
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.

​
Body parameters

​
name
string
Name of the property.
​
display_name
string
Display name of the property.
​
description
string
Description of the property.
​
property_type
string
Type of the property.
​
relation_type
string
Relation type of the property.
​
is_required
boolean
Whether the property is required.
​
is_multi
boolean
Whether the property supports multiple values.
​
is_active
boolean
Whether the property is active.
​
sort_order
number
Sort order for the property.
​
default_value
string[]
Default values for the property.
​
settings
object
Settings for the property.
​
validation_rules
object
Validation rules for the property.
​
logo_props
object
Logo properties for the property.
​
external_source
string
External source identifier.
​
external_id
string
External ID from the external source.