Create a customer property

POST/api/v2/workspaces/{slug}/customer-properties/

Customer properties are the workspace-level custom field catalog for customers. Create a customer property.

Path Parameters

slug:requiredstring

The workspace slug. It appears in your Plane URLs — in https://app.plane.so/my-team/projects/, the slug is my-team.

Body Parameters

display_name:requiredstring

The display name.

Maximum 255 characters.

property_type:requiredstring

• TEXT - Text
• DATETIME - Datetime
• DECIMAL - Decimal
• BOOLEAN - Boolean
• OPTION - Option
• RELATION - Relation
• URL - URL
• EMAIL - Email
• FILE - File

One of TEXT, DATETIME, DECIMAL, BOOLEAN, OPTION, RELATION, URL, EMAIL, FILE.

default_value:optionalarray of string

The default value.

description:optionalstring

Free-form description.

Nullable.

external_id:optionalstring

Your system's identifier for this record, for sync and import correlation.

Maximum 255 characters. Nullable.

external_source:optionalstring

The system external_id came from, for example github or jira.

Maximum 255 characters. Nullable.

is_active:optionalboolean

Whether the record is active.

is_multi:optionalboolean

Whether is multi.

is_required:optionalboolean

Whether is required.

logo_props:optionalstring

Editor-owned logo descriptor. Pass back what you read rather than composing it by hand.

options:optionalarray of object

The options.

relation_type:optionalstring

• ISSUE - Issue
• USER - User

One of ISSUE, USER. Nullable.

settings:optionalstring

The settings.

validation_rules:optionalstring

The validation rules.

Response shaping

fields:optionalstring

Comma-separated list of fields to return. Unrequested keys are omitted, not returned as null. id always comes back. Pass all for every requestable field. An unknown name is a 400. See Sparse fields.

Requestable here: created_at, created_by_id, default_value, description, display_name, external_id, external_source, id, is_active, is_multi, is_required, logo_props, name, options, property_type, relation_type, settings, sort_order, validation_rules.

Scopes

customers.properties:write

Errors

Status	Code	Cause
400	invalid_request	The request body or a query parameter failed validation.
401	unauthorized	Missing or invalid credentials.
402	payment_required	The feature this endpoint belongs to isn't enabled on your plan or is switched off.
403	forbidden	Your role or token scope doesn't allow this.
404	not_found	No such resource, or it's outside your tenant.
406	not_acceptable	The Accept header asks for a representation the API can't produce.
409	conflict	A business rule blocks the write — see the notes above.
413	payload_too_large	The request body is over the size limit.
415	unsupported_media_type	The Content-Type isn't one this endpoint accepts.
429	rate_limited	Throttled. Honor the Retry-After header before retrying.

Create a customer property

curl -X POST \
  "https://api.plane.so/api/v2/workspaces/my-team/customer-properties/" \
  -H "X-Api-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "display_name": "example",
  "property_type": "TEXT",
  "default_value": [
    "example"
  ],
  "description": "What this is for.",
  "external_id": null
}'

import requests

response = requests.post(
    "https://api.plane.so/api/v2/workspaces/my-team/customer-properties/",
    headers={"X-Api-Key": "your-api-key"},
    json={
        "display_name": "example",
        "property_type": "TEXT",
        "default_value": [
            "example"
        ],
        "description": "What this is for.",
        "external_id": None
    },
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/customer-properties/",
  {
    method: "POST",
    headers: {
      "X-Api-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      display_name: "example",
      property_type: "TEXT",
      default_value: ["example"],
      description: "What this is for.",
      external_id: null,
    }),
  },
);
const data = await response.json();

Response201

{
  "created_at": "2026-01-14T09:22:41.478363Z",
  "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "default_value": ["example"],
  "description": "What this is for.",
  "display_name": "example",
  "external_id": null,
  "external_source": null,
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "is_active": true,
  "is_multi": false,
  "is_required": false,
  "logo_props": null,
  "name": "Example name",
  "options": [null],
  "property_type": "TEXT",
  "relation_type": null,
  "settings": null,
  "sort_order": 65535,
  "validation_rules": null
}