Update a property option

Changed on
patch/v2/prism/{teamId}/document/properties/{propertyId}/options/{optionId}

Request

  • Base URL
    https://developers.micro.so
  • URL
    https://developers.micro.so/v2/prism/{teamId}/document/properties/{propertyId}/options/{optionId}
  • Auth
    API key in header x-api-key

Path parameters

teamIdstring uuid 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) for an authenticated POST, PUT, or PATCH request. The server retains the initial claim for 24 hours and replays a completed non-5xx response only when the method, path, and request body all match. Reusing a non-expired key with a different method, path, or body returns 409 idempotency_key_mismatch; reusing it after expiry returns 409 idempotency_key_stale, so use a new key. 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

Changes

  • 558afa74332eRevision changes
    • breaking

      removed the enum value multiref_agent_artifact of the request property

    • info

      added the new multiref_agent_site enum value to the request property

  • aa8d5fd72a2bRevision changes
    • breaking

      added the pattern ^(app_stage|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ to the path request parameter propertyId

    • breaking

      removed the enum value multiref_organization_user of the request property

    • breaking

      removed the enum value ref_organization_user of the request property

    • info

      for the path request parameter propertyId, the format was generalized from uuid to no format

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status