Skip to main content
PUT
Update Property Definition

Headers

authorization
string | null
X-Organization-ID
string | null

Path Parameters

key
string
required

Cookies

stytch_session
string | null

Body

application/json

The body is of type Updates · object.

Response

Successful Response

Response model for a single PropertyDefinition.

id
string
required

MongoDB ObjectId as string

key
string
required
name
string
required
type
Type · object
required
aiCanAddANewValue
boolean
default:true
aiMatchingGuidance
string | null
attributeConstraint
string | null
category
string | null
createdAt
string | null
createdBy
string | null
description
Description · object[] | null
display_group
string | null
display_order
integer | null
default:0
enrichment_config
Enrichment Config · object | null
facet_value_sort
string
default:asc
identifier_type
string | null

Identifier type (lower snake_case) when is_identifier is true

inputHint
string | null
isActive
boolean
default:true
isFacetable
boolean
default:false
isMultiValue
boolean
default:false
isRequired
boolean
default:false
isSearchable
boolean
default:false
isVisibleInStorefront
boolean
default:true
is_common
boolean
default:false

Common property flag

is_entry_field
boolean
default:false

Entry field flag

is_identifier
boolean
default:false

Use values as identifiers for lakehouse matching

is_system
boolean
default:false

System property flag

label
Label · object[]
lastModifiedAt
string | null
lastModifiedBy
string | null
level
string | null
mustBeAccurateToAssign
boolean
default:false
prompt_name
string | null
scope
string
default:catalog

Scope: 'catalog' or 'lakehouse'

ui_widget
string
default:text_input
valueCount
integer
default:0

Number of enum values

visibility
string
default:list_and_detail