Excel Add-In for Box

Build 25.0.9434

ShareAnItem

Creates or updates a shared link for a file, folder, or bookmark, enabling controlled external access.

Input

Name Type Description
ItemId String The Id of the item to share.
ItemType String The type of item being shared, such as a file, folder, or bookmark.

The allowed values are file, folder, bookmark.

The default value is file.

Access String Specifies the access level of the shared link, such as open, company, or collaborators.

The allowed values are open, company, collaborators.

The default value is open.

Unshared_At String The expiration date when the shared link is automatically disabled.
Password String A password required to access the shared link, if enabled.
Can_Preview Boolean Indicates whether the item can be previewed through the shared link. Can only be set with open or company access.

The default value is true.

Can_Download Boolean Indicates whether the item can be downloaded through the shared link. Applicable only to files and folders, not bookmarks. Can only be set with open or company access.

The default value is true.

AsUserId String The Id of the user you want to impersonate. Only works with Admin, Co-Admin, and Service Accounts.

Result Set Columns

Name Type Description
Url String The URL of the newly created shared link.
Download_Url String The direct download URL for the shared item.
Download_Count String The number of times the item has been downloaded from the shared link.
Is_Password_Enabled String Indicates whether the shared link is protected by a password.
Unshared_At String The expiration date when the shared link was or will be disabled.
Preview_Count String The number of times the item has been previewed through the shared link.
Effective_Access String The effective access level applied to the shared link, as enforced by administrators.
Success String Whether or not the item was successfully shared.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434