Update a customer property

PATCH/api/v2/workspaces/{slug}/customer-properties/{pk}/

Customer properties are the workspace-level custom field catalog for customers. Update a customer property. Send only the keys you want to change. Omitted keys keep their current value, and an explicit null clears a nullable field.

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.

pk:requiredstring (uuid)

The customer property id.

Body parameters

default_value:optionalarray of string

The default value.

description:optionalstring

Free-form description.

Nullable.

display_name:optionalstring

The display name.

Maximum 255 characters.

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 the property accepts more than one value.

is_required:optionalboolean

Whether the property is required.

logo_props:optionalstring

Logo descriptor managed by the Plane editor. Send back the value you read instead of building it by hand.

options:optionalarray of object

The choices for an OPTION property.

property_type:optionalstring

• 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.

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. Fields you don't request are left out of the response instead of coming back as null. id is always included. Pass all to get every requestable field. An unknown field name returns 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, updated_at, updated_by_id, 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.
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.

Update a customer property

curl -X PATCH \
  "https://api.plane.so/api/v2/workspaces/my-team/customer-properties/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/" \
  -H "X-Api-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "default_value": [
    "example"
  ],
  "description": "What this is for.",
  "display_name": "example"
}'

import requests

response = requests.patch(
    "https://api.plane.so/api/v2/workspaces/my-team/customer-properties/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/",
    headers={"X-Api-Key": "your-api-key"},
    json={
        "default_value": [
            "example"
        ],
        "description": "What this is for.",
        "display_name": "example"
    },
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/customer-properties/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/",
  {
    method: "PATCH",
    headers: {
      "X-Api-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      default_value: ["example"],
      description: "What this is for.",
      display_name: "example",
    }),
  },
);
const data = await response.json();

Response200

{
  "created_at": "2026-01-14T09:22:41.478363Z",
  "updated_at": "2026-02-03T16:45:12.904117Z",
  "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "updated_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
}

Response404

{
  "type": "not_found",
  "code": "not_found",
  "detail": "No customer property matches the given query."
}