Excel Add-In for Box

Build 24.0.9060

ShareAnItem

Shares a File, Folder or Bookmark.

Input

Name Type Description
ItemId String The Id of the item to share.
ItemType String Specify the type of the item you want to share.

The allowed values are file, folder, bookmark.

The default value is file.

Access String Access property of the shared link.

The allowed values are open, company, collaborators.

The default value is open.

Unshared_At String Date to delete the shared link.
Password String Password of the shared link.
Can_Preview Boolean If the item should be available for preview. Can only be used with open and company access.

The default value is true.

Can_Download Boolean If the item should be available for download. Set this property only when you are trying to share a folder or a file and not a bookmark. Can only be used with open and company.

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 newly created shared link for the item
Download_Url String The download URL for the item.
Download_Count String How many times the item has been downloaded from this shared link.
Is_Password_Enabled String If the URL is password-enabled or not.
Unshared_At String Date the item was or will be deleted.
Preview_Count String How many times the item has been previewed from this shared link.
Effective_Access String Access level set by an admin.
Success String Whether or not the file was successfully shared.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060