Update metadata property option
Update metadata property option using the reviewed public Micro API contract. Authentication uses the x-api-key header.
/v2/prism/{teamId}/{objectType}/properties/{propertyId}/options/{optionId}Authorization
apiKey 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
uuidObject 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"
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.
^(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})$uuidHeader Parameters
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.
1 <= length <= 255Request Body
application/json
Partial update of a property option. type identifies the per-type option 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}/options/${OPTION_ID}" \ -H "x-api-key: $MICRO_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "type": "num" }'{ "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"}