IRPCSharedLinks.SetSharedLinkRecipients

Vault API / standard write session or assertion returns metadata structure version

Updates the expiration time and access type of visitors of external links.

Service	Shared links `MFiles.IRPCSharedLinks`
gRPC method	`/MFiles.IRPCSharedLinks/SetSharedLinkRecipients`
HTTP (mf-http-grpc)	`POST /grpc/v1/set-shared-link-recipients`
Request	`SetSharedLinkRecipientsRequest`
Response	`SetSharedLinkRecipientsResponse`
Book and level	Vault API, standard
Kind	write
Session	Required: a session (mfiles-session-id-bin metadata) or a session assertion (x-mf-session-assertion metadata).
Idempotent	no
Returns metadata structure version	yes (in the mfiles-metadata-version-bin trailer)
Streaming	none (unary)

Remarks

Each entry names a link (access_key) and a recipient (recipient.email, the plain address). recipient.expires_at_utc must be in the future; otherwise the call fails with "The parameter is incorrect.".
Users who cannot see the full list of visitors can update only the recipients they added; other entries are left unchanged.

Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.

Field	Type	Description
`recipients[]`	repeated `SetSharedLinkRecipient`	The recipients to update, each with the link's `access_key` and the new `expires_at_utc` and `external_shared_link_access_type`.
`recipients[].access_key`	`string`	The access key of the shared link.
`recipients[].recipient`	`SharedLinkRecipient`	The information about the shared link recipient linked to the access key to update expiration time and access type.
`recipients[].recipient.email`	`string`	The recipient email.
`recipients[].recipient.access_time`	`google.protobuf.Timestamp`	The access time for the shared link. Is set by the server.
`recipients[].recipient.created_by_user`	`int32`	The creator of this shared Link.
`recipients[].recipient.shared_link_notification`	`SharedLinkNotification`	Shared link notification type.Values: `SHARED_LINK_NOTIFICATION_NONE` (0), `SHARED_LINK_NOTIFICATION_ALWAYS` (1).
`recipients[].recipient.expires_at_utc`	`google.protobuf.Timestamp`	The expiration time for the shared link. Use FILETIME_ZERO to indicate no expiration time.
`recipients[].recipient.external_shared_link_access_type`	`ExternalSharedLinkAccessType`	The access type of the recipient.Values: `EXTERNAL_SHARED_LINK_ACCESS_TYPE_UNINITIALIZED` (0), `EXTERNAL_SHARED_LINK_ACCESS_TYPE_DOWNLOAD` (1), `EXTERNAL_SHARED_LINK_ACCESS_TYPE_PREVIEW` (2), `EXTERNAL_SHARED_LINK_ACCESS_TYPE_EDIT` (3).
`recipients[].recipient.created_by_user_name`	`string`	The user who created the shared link.

Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.

Field	Type	Description
`recipients[]`	repeated `SetSharedLinkRecipient`	The updated recipients.
`recipients[].access_key`	`string`	The access key of the shared link.
`recipients[].recipient`	`SharedLinkRecipient`	The information about the shared link recipient linked to the access key to update expiration time and access type.
`recipients[].recipient.email`	`string`	The recipient email.
`recipients[].recipient.access_time`	`google.protobuf.Timestamp`	The access time for the shared link. Is set by the server.
`recipients[].recipient.created_by_user`	`int32`	The creator of this shared Link.
`recipients[].recipient.shared_link_notification`	`SharedLinkNotification`	Shared link notification type.Values: `SHARED_LINK_NOTIFICATION_NONE` (0), `SHARED_LINK_NOTIFICATION_ALWAYS` (1).
`recipients[].recipient.expires_at_utc`	`google.protobuf.Timestamp`	The expiration time for the shared link. Use FILETIME_ZERO to indicate no expiration time.
`recipients[].recipient.external_shared_link_access_type`	`ExternalSharedLinkAccessType`	The access type of the recipient.Values: `EXTERNAL_SHARED_LINK_ACCESS_TYPE_UNINITIALIZED` (0), `EXTERNAL_SHARED_LINK_ACCESS_TYPE_DOWNLOAD` (1), `EXTERNAL_SHARED_LINK_ACCESS_TYPE_PREVIEW` (2), `EXTERNAL_SHARED_LINK_ACCESS_TYPE_EDIT` (3).
`recipients[].recipient.created_by_user_name`	`string`	The user who created the shared link.