create_customer_property
Create a workspace-wide custom field for customer records. Define its type, required status, default value, and visibility to capture tailored customer data.
Instructions
Create a customer property (a workspace-wide custom field on customers).
property_type, is_multi and settings are fixed once created — recreate the property to change them.
Args: name: Required, but discarded — the stored name is a slug of display_name. Pass display_name here too if you have nothing else. display_name: User-facing label. Must be unique in the workspace: it derives the property's slug, so a display name already in use is rejected. property_type: TEXT | DATETIME | DECIMAL | BOOLEAN | OPTION | RELATION | URL | EMAIL | FILE relation_type: ISSUE | USER — required when property_type=RELATION description: Property description is_required: Whether a value must be set; forces default_value to be empty default_value: Default value(s); at most one unless is_multi settings: Required for TEXT/DATETIME. TEXT: {"display_format": "single-line"|"multi-line"|"readonly"} DATETIME: {"display_format": "MMM dd, yyyy"|"dd/MM/yyyy"|"MM/dd/yyyy"|"yyyy/MM/dd"} is_active: Whether the property is active is_multi: Whether the property holds multiple values options: For OPTION type — [{"name": str, "description"?: str, "is_default"?: bool}] external_source: External system this property came from, e.g. "salesforce" external_id: The property's ID in that external system
Returns: The created CustomerProperty, including its options for OPTION type
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | ||
| options | No | ||
| is_multi | No | ||
| settings | No | ||
| is_active | No | ||
| description | No | ||
| external_id | No | ||
| is_required | No | ||
| display_name | Yes | ||
| default_value | No | ||
| property_type | Yes | ||
| relation_type | No | ||
| external_source | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ||
| name | No | ||
| options | No | ||
| is_multi | No | ||
| settings | No | ||
| is_active | No | ||
| workspace | No | ||
| created_at | No | ||
| created_by | No | ||
| deleted_at | No | ||
| logo_props | No | ||
| sort_order | No | ||
| updated_at | No | ||
| updated_by | No | ||
| description | No | ||
| external_id | No | ||
| is_required | No | ||
| display_name | Yes | ||
| default_value | No | ||
| property_type | Yes | ||
| relation_type | No | ||
| external_source | No | ||
| validation_rules | No |