Skip to content
API Reference
Properties

Update metadata property

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}/{objectType}/properties/{propertyId}

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.

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
Formatuuid

Header Parameters

Idempotency-Key?string

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.

Length1 <= length <= 255

Request Body

application/json

Partial update of a property definition. Only name, icon, enabled, and required are editable. type identifies the per-type table to write.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://developers.micro.so/v2/prism/${MICRO_TEAM_ID}/comment/properties/${PROPERTY_ID}" \  -H "x-api-key: $MICRO_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "type": "num"  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "slug": "string",  "name": "string",  "type": "num",  "team_id": "810007d0-bec5-486c-b5d1-28fcd8a079ba",  "crm_id": "a1cca198-42e1-4e72-a0e1-017dec9db0e1",  "list_id": "430bbdbc-9d7f-4d06-a273-67ca4ba4ae4b",  "native": true,  "locked": true,  "alias": "app_stage",  "required": true,  "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",  "options": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "slug": "string",      "value": "string",      "color_scheme": "string",      "sort_index": 0,      "icon": "string",      "description": "string",      "option_group": "string",      "list_id": "430bbdbc-9d7f-4d06-a273-67ca4ba4ae4b",      "crm_id": "a1cca198-42e1-4e72-a0e1-017dec9db0e1"    }  ]}
micro.so