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

Delete a property definition

prism.properties.delete(strproperty_id, PropertyDeleteParams**kwargs)
DELETE/v2/prism/{teamId}/{objectType}/properties/{propertyId}

Removes the property definition and any of its options. Fails with 409 property_in_use if records still reference the property.

ParametersExpand Collapse
team_id: Optional[str]
formatuuid
object_type: Literal["comment", "deal", "engagement", 9 more]
One of the following:
"comment"
"deal"
"engagement"
"identity"
"ai_chat_thread"
"ai_chat_message"
"agent_site"
"document"
"action"
"event"
"organization"
"contact"
property_id: str
formatuuid
type: Literal["num", "str", "bool", 34 more]

Storage type of this property definition.

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"
list_id: Optional[str]
formatuuid

Delete a property definition

import os
from micro_so import Micro

client = Micro(
    api_key=os.environ.get("MICRO_API_KEY"),  # This is the default and can be omitted
)
client.prism.properties.delete(
    property_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    object_type="comment",
    type="num",
)
Returns Examples