Skip to content
ChangelogGo to console
API Reference
Properties

Delete metadata property option

Delete metadata property option using the reviewed public Micro API contract. Authentication uses the x-api-key header.

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

Authorization

apiKey
x-api-key<token>

Public API key generated from Micro settings. Sent as the x-api-key header and validated by AWS API Gateway in front of the service.

In: header

Path Parameters

teamId*string
Formatuuid
objectType*string

Object types that support CRUD, query, list, and per-type property metadata. GET /v2/prism/{teamId}/properties (list-all) also returns definitions for pipeline-owned types that are not in this set — including message, thread, and linkedin_thread. Those types are not queryable. Contacts expose last_email as a ref_message; you cannot query message to follow it.

Value in

  • "comment"
  • "deal"
  • "engagement"
  • "identity"
  • "ai_chat_thread"
  • "ai_chat_message"
  • "agent_site"
  • "document"
  • "action"
  • "event"
  • "organization"
  • "contact"
propertyId*string

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.

Match^(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})$
optionId*string
Formatuuid

Query Parameters

type*string

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

Value in

  • "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?string
Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://developers.micro.so/v2/prism/${MICRO_TEAM_ID}/comment/properties/${PROPERTY_ID}/options/${OPTION_ID}?type=num" \  -H "x-api-key: $MICRO_API_KEY"
Empty

Delete

Previous Page

List

Next Page

micro.so