Skip to main content
PATCH
Update property

Authorizations

Authorization
string
header
required

Enter your API key. Example: Bearer poelis_api_...

Path Parameters

property_id
string
required

Query Parameters

type
string
required

Property type: numeric, matrix, text, date, or status

Body

application/json

Request to update a property.

name
string | null

Property name

Minimum string length: 1
readable_id
string | null

Human-readable property ID (must be unique within item). Only lowercase letters, numbers and underscores are allowed.

Minimum string length: 1
Pattern: ^[a-z0-9_]+$
value
any | null

Property value

display_unit
string | null

Display unit (numeric and matrix only)

Response

Updated property

Unified public property representation.

id
string
required
readable_id
string
required

Human-readable property ID

item_id
string
required
name
string
required
type
enum<string>
required
Available options:
numeric,
text,
date,
status,
matrix,
formula
value
any
required

Property value. Numeric: plain number or matrix (category/display_unit always set; matrix value string e.g. "[[1,2,3],[4,5,6]]") or formula (category/display_unit never set; value is the result of the computation including unit if any). Text: string. Date: string, ISO date (e.g. "2025-01-29"). Status: string, one of "Draft", "Under Review", "Done".

deleted
boolean
required
category
string | null

Category. For numeric (plain number or matrix) always set; for formula never set.

display_unit
string | null

Display unit. For numeric (plain number or matrix) always set; for formula never set.

draft_property_id
string | null
references
PublicPropertyReference · object[]

References to source documents for this property

formula_expression
string | null

Formula expression for numeric properties that calculate their value from other properties. Uses @{property_id} syntax to reference dependencies. The value field holds the result of this computation, including unit if any.

createdBy
PublicUser · object | null

User who created the property

Example:
createdAt
string | null

ISO 8601 creation timestamp

updatedAt
string | null

ISO 8601 last-update timestamp

updatedBy
PublicUser · object | null

User who last updated the property

Example: