Skip to content
API Reference
Sharing

Update grant

Update grant using the reviewed public Micro API contract. Authentication uses the x-api-key header.

PUT/v2/prism/{teamId}/{objectType}/{objectId}/grant
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 whose per-record access grants can be managed. Adds message to the CRUD-capable ObjectType set: messages are owned by the Gmail sync pipeline and have no create/update/delete surface, but their access rows can still be read and written.

Value in

  • "comment"
  • "deal"
  • "engagement"
  • "identity"
  • "ai_chat_thread"
  • "ai_chat_message"
  • "agent_site"
  • "document"
  • "action"
  • "event"
  • "organization"
  • "contact"
  • "message"
objectId*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

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://developers.micro.so/v2/prism/${MICRO_TEAM_ID}/comment/${RECORD_ID}/grant" \  -H "x-api-key: $MICRO_API_KEY" \  -H "Content-Type: application/json" \  -d '{}'
{  "user_id": {    "property1": "a",    "property2": "a"  },  "team_id": {    "property1": "a",    "property2": "a"  },  "group_id": {    "property1": "a",    "property2": "a"  },  "share_level": "metadata",  "contact_ids": [    "f4ae0292-6c1e-4caf-903f-b55ea2c1670a"  ],  "identity_ids": [    "fca1bb67-1347-47e5-be45-c005a336d0ce"  ],  "organization_ids": [    "7d4232d7-54a0-4c93-9c1e-a8fd2dfcdabe"  ]}
micro.so