Update grant

Changed on
put/v2/prism/{teamId}/document/{documentId}/grant

Request

  • Base URL
    https://developers.micro.so
  • URL
    https://developers.micro.so/v2/prism/{teamId}/document/{documentId}/grant
  • Auth
    API key in header x-api-key

Path parameters

teamIdstring uuid required
documentIdstring uuid required

Headers

Idempotency-Keystring

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.

Request body

OR
OR

Response

Grant updated

user_idobject
team_idobject
group_idobject
share_level'metadata' | 'full'

How much of the record the grant exposes. metadata shares only the record's headers and participants; full shares its contents. Currently recorded on the access row and returned on read — it is not yet enforced by the read path. Applies to message grants; ignored for other object types.

contact_idsstring[] nullable
identity_idsstring[] nullable
organization_idsstring[] nullable

Changes

  • df4219e7e84bRevision changes
    • breaking

      the response's property type changed from array to object for status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional request property

    • info

      removed subschema #1 subschema #2 subschema #3 from the response body anyOf list for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added 'propertyNames' constraint to the response property for the status

  • fdc16d4f0be0Revision changes
    • info

      endpoint added