Update a property definition

Changed on

Patches the editable fields (name, icon, enabled) of a property definition. type and scoping fields are immutable; type must be supplied in the body so the server knows which per-type table to write.

patch/v2/prism/{teamId}/organization/properties/{propertyId}

Request

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

Path parameters

teamIdstring uuid required
propertyIdstring 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
namestring
iconstring nullable
enabledboolean
requiredboolean

Response

Property updated

idstring uuid required
slugstring required
namestring nullable
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.

team_idstring uuid nullable
crm_idstring uuid nullable

Identifier of the list this definition is scoped to, when applicable.

list_idstring uuid nullable

Canonical identifier of the list this definition is scoped to.

nativeboolean
lockedboolean
alias'app_stage' | 'null' nullable

Reserved alias naming this definition, or null. app_stage marks the list pipeline stage definition. Resolve stages by this field rather than by name, slug, or team_id: a superseded native status definition can coexist with the pipeline one and is otherwise identical on the wire.

requiredboolean

When true, records of this object type must carry a non-empty value for this property on create, and a patch may not clear it.

role_idstring uuid nullable

The property's display format. Always populated on definitions created through this API; a null here means the definition predates that and will render as an unknown format until it is patched.

Changes

  • 558afa74332eRevision changes
    • breaking

      removed the enum value multiref_agent_artifact of the request property

    • warning

      added the new multiref_agent_site enum value to the response property for the response status

    • info

      added the new multiref_agent_site enum value to the request property

    • info

      removed the multiref_agent_artifact enum value from the response property for the response status

  • aa8d5fd72a2bRevision changes
    • 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

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      removed the multiref_organization_user enum value from the response property for the response status

    • info

      removed the ref_organization_user enum value from the response property for the response status