add-customer-property.md

title	Create a customer property
description	Create a customer property via Plane API. HTTP POST request format, required fields, and example responses.
keywords	plane, plane api, rest api, api integration, customers, crm, customer management

Create a customer property

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

Creates a new customer property definition in a workspace.

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.

Body Parameters

Name of the property.

Display name of the property.

Description of the property.

Type of the property.

Relation type of the property.

Whether the property is required.

Whether the property supports multiple values.

Whether the property is active.

Sort order for the property.

Default values for the property.

Settings for the property.

Validation rules for the property.

Logo properties for the property.

External source identifier.

External ID from the external source.

Scopes

customers.properties:write

curl -X POST \
  "https://api.plane.so/api/v1/workspaces/my-workspace/customer-properties/" \
  -H "X-API-Key: $PLANE_API_KEY" \
  # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
  -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();

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