Skip to content
Micro micro
Go to Micro
API Reference
Prism
Properties

Options

Add an option to a select property
POST/v2/prism/{teamId}/{objectType}/properties/{propertyId}/options
Update a property option
PATCH/v2/prism/{teamId}/{objectType}/properties/{propertyId}/options/{optionId}
Delete a property option
DELETE/v2/prism/{teamId}/{objectType}/properties/{propertyId}/options/{optionId}
ModelsExpand Collapse
PropertyOption object { id, slug, color_scheme, 7 more }

An enabled option for a select_str or multiselect_str property definition.

id: string
formatuuid
slug: string
color_scheme: optional string
Deprecatedcrm_id: optional string
formatuuid
description: optional string
icon: optional string
list_id: optional string
formatuuid
option_group: optional string
sort_index: optional number
value: optional string

Display value for the option.

PropertyOptionCreate object { type, value, color_scheme, 6 more }

New option for a select_str or multiselect_str property. type identifies the per-type option table to write.

type: "num" or "str" or "bool" or 34 more

Storage type for a property definition. Determines which per-type table holds the values, and which display formats the property can take.

One of the following:
"num"
"str"
"bool"
"date"
"text"
"byte"
"select_str"
"multi_str"
"multiselect_str"
"jsonb"
"ref_identity"
"ref_user"
"ref_organization"
"ref_contact"
"ref_thread"
"ref_message"
"ref_event"
"ref_account"
"ref_ai_chat_thread"
"ref_ai_chat_message"
"multiref_ai_chat_message"
"multiref_agent_site"
"multiref_action"
"multiref_comment"
"multiref_contact"
"multiref_label"
"multiref_thread"
"multiref_messages"
"multiref_document"
"multiref_identity"
"multiref_organization"
"multiref_engagement"
"multiref_attendee"
"multiref_meeting_entry"
"multiref_read_receipt"
"multiref_account"
"multiref_source"
value: string

Display value for the option.

color_scheme: optional string
description: optional string
icon: optional string
list_id: optional string

Scope the option to a specific list/app.

formatuuid
option_group: optional string
slug: optional string

URL-safe identifier. Defaults to a slugified value.

sort_index: optional number
PropertyOptionPatch object { type, color_scheme, description, 7 more }

Partial update of a property option. type identifies the per-type option table to write.

type: "num" or "str" or "bool" or 34 more

Storage type for a property definition. Determines which per-type table holds the values, and which display formats the property can take.

One of the following:
"num"
"str"
"bool"
"date"
"text"
"byte"
"select_str"
"multi_str"
"multiselect_str"
"jsonb"
"ref_identity"
"ref_user"
"ref_organization"
"ref_contact"
"ref_thread"
"ref_message"
"ref_event"
"ref_account"
"ref_ai_chat_thread"
"ref_ai_chat_message"
"multiref_ai_chat_message"
"multiref_agent_site"
"multiref_action"
"multiref_comment"
"multiref_contact"
"multiref_label"
"multiref_thread"
"multiref_messages"
"multiref_document"
"multiref_identity"
"multiref_organization"
"multiref_engagement"
"multiref_attendee"
"multiref_meeting_entry"
"multiref_read_receipt"
"multiref_account"
"multiref_source"
color_scheme: optional string
description: optional string
enabled: optional boolean
icon: optional string
list_id: optional string
formatuuid
option_group: optional string
slug: optional string
sort_index: optional number
value: optional string