Sign in

v25

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-0131545750.2 KB

Update a property option

patch/v2/prism/{teamId}/{objectType}/properties/{propertyId}/options/{optionId}

Path parameters

teamIdstring uuid required
objectType'comment' | 'deal' | 'engagement' | 'identity' | 'ai_chat_thread' | 'ai_chat_message' | 'agent_site' | 'document' | 'action' | 'event' | 'organization' | 'contact' required
propertyIdstring required

Property definition uuid, or the reserved alias app_stage for the list pipeline stage definition (requires list_id). The alias exists because a superseded native status definition can coexist with the pipeline one and the two are indistinguishable in a metadata read; the definition carrying alias: app_stage is the pipeline one.

optionIdstring uuid required

Headers

Idempotency-Keystring

A unique key (UUID or any opaque string up to 255 chars) that identifies this logical request. The server caches the first response under this key for 24 hours and replays it on retry — safe to use on every POST/PUT/PATCH to make network retries deterministic. Reusing the same key with a different body returns 409 idempotency_key_mismatch. Replays include the idempotent-replay: true response header.

Request body

type'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' required

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

list_idstring uuid nullable
valuestring
slugstring
color_schemestring nullable
sort_indexinteger nullable
iconstring nullable
descriptionstring nullable
option_groupstring nullable
enabledboolean

Response

Option updated

idstring uuid required
slugstring required
valuestring nullable

Display value for the option.

color_schemestring nullable
sort_indexinteger nullable
iconstring nullable
descriptionstring nullable
option_groupstring nullable
list_idstring uuid nullable
crm_idstring uuid nullable