Skip to content
Go to Micro

Messages

MessagesGrant

Get grant
GET/v2/prism/{teamId}/message/{messageId}/grant
Update grant
PUT/v2/prism/{teamId}/message/{messageId}/grant
ModelsExpand Collapse
GrantGetResponse object { contact_ids, group_id, identity_ids, 4 more }

The grants on a record. For message, also carries the entity ids of everyone on the message, resolved from its address headers when the grant was written. The id arrays are read-only and are null when participant resolution was unavailable (for example the mailbox had no Gmail token at the time).

contact_ids: optional array of string
group_id: optional map["a" or "r" or "w"]
One of the following:
"a"
"r"
"w"
identity_ids: optional array of string
organization_ids: optional array of string
share_level: optional "metadata" or "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.

One of the following:
"metadata"
"full"
team_id: optional map["a" or "r" or "w"]
One of the following:
"a"
"r"
"w"
user_id: optional map["a" or "r" or "w"]
One of the following:
"a"
"r"
"w"
GrantUpdateResponse object { contact_ids, group_id, identity_ids, 4 more }

The grants on a record. For message, also carries the entity ids of everyone on the message, resolved from its address headers when the grant was written. The id arrays are read-only and are null when participant resolution was unavailable (for example the mailbox had no Gmail token at the time).

contact_ids: optional array of string
group_id: optional map["a" or "r" or "w"]
One of the following:
"a"
"r"
"w"
identity_ids: optional array of string
organization_ids: optional array of string
share_level: optional "metadata" or "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.

One of the following:
"metadata"
"full"
team_id: optional map["a" or "r" or "w"]
One of the following:
"a"
"r"
"w"
user_id: optional map["a" or "r" or "w"]
One of the following:
"a"
"r"
"w"