Create a customer property

POST/api/v1/workspaces/{workspace_slug}/customer-properties/

Creates a new customer property definition in a workspace.

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.

Body Parameters

name:optionalstring

Name of the property.

display_name:optionalstring

Display name of the property.

description:optionalstring

Description of the property.

property_type:optionalstring

Type of the property.

relation_type:optionalstring

Relation type of the property.

is_required:optionalboolean

Whether the property is required.

is_multi:optionalboolean

Whether the property supports multiple values.

is_active:optionalboolean

Whether the property is active.

sort_order:optionalnumber

Sort order for the property.

default_value:optionalstring[]

Default values for the property.

settings:optionalobject

Settings for the property.

validation_rules:optionalobject

Validation rules for the property.

logo_props:optionalobject

Logo properties for the property.

external_source:optionalstring

External source identifier.

external_id:optionalstring

External ID from the external source.

Create a customer property

curl -X POST \
  "https://api.plane.so/api/v1/workspaces/my-workspace/customer-properties/" \
  -H "X-API-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "example-name",
  "display_name": "example-display_name",
  "description": "example-description",
  "property_type": "example-property_type",
  "relation_type": "example-relation_type",
  "is_required": true,
  "is_multi": true,
  "is_active": true,
  "sort_order": 1,
  "default_value": "example-default_value",
  "settings": "example-settings",
  "validation_rules": "example-validation_rules",
  "logo_props": "example-logo_props",
  "external_source": "example-external_source",
  "external_id": "example-external_id"
}'

import requests

response = requests.post(
    "https://api.plane.so/api/v1/workspaces/my-workspace/customer-properties/",
    headers={"X-API-Key": "your-api-key"},
    json={
  'name': 'example-name',
  'display_name': 'example-display_name',
  'description': 'example-description',
  'property_type': 'example-property_type',
  'relation_type': 'example-relation_type',
  'is_required': true,
  'is_multi': true,
  'is_active': true,
  'sort_order': 1,
  'default_value': 'example-default_value',
  'settings': 'example-settings',
  'validation_rules': 'example-validation_rules',
  'logo_props': 'example-logo_props',
  'external_source': 'example-external_source',
  'external_id': 'example-external_id'
}
)
print(response.json())

const response = await fetch('https://api.plane.so/api/v1/workspaces/my-workspace/customer-properties/', {
  method: 'POST',
  headers: {
    'X-API-Key': 'your-api-key',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'example-name',
    display_name: 'example-display_name',
    description: 'example-description',
    property_type: 'example-property_type',
    relation_type: 'example-relation_type',
    is_required: true,
    is_multi: true,
    is_active: true,
    sort_order: 1,
    default_value: 'example-default_value',
    settings: 'example-settings',
    validation_rules: 'example-validation_rules',
    logo_props: 'example-logo_props',
    external_source: 'example-external_source',
    external_id: 'example-external_id',
  }),
});
const data = await response.json();

Response201

{
  "id": "resource-uuid",
  "created_at": "2024-01-01T00:00:00Z"
}