activities
latest
false
UiPath logo, featuring letters U and I in white

Integration Service Activities

Last updated Feb 19, 2026

Add Shared Link to Folder

Project compatibility

Windows | Cross-platform

Overview

DescriptionAPI MethodAPI Path
Create a shared link for a folder in Box.PUT/folders/{folder_id}/add_shared_link

Input

ParameterDescriptionData Type
FolderThe folder object for which the shared link is being created. data list
AccessDefines who can access the shared link. Supported values:
  • Open – Anyone with the link
  • Company – Only users within your organization
  • Collaborators – Only collaborators of the folder
options
PasswordAn optional password required to access the shared link. Set to null to remove it. Passwords must be at least 8 characters long and include a number, an uppercase letter, or a symbol. Passwords can only be set when access = open. string
DownloadIndicates whether users can download items through the shared link. This can only be enabled when access = open or company. boolean
PreviewIndicates whether users can preview items in the folder through the shared link. This is always true and applies to all items within the folder. boolean
Unshare timeOptional timestamp specifying when the shared link will automatically expire. date time
EditIndicates whether items in the folder can be edited through the shared link. This can only be false for items of type folder. boolean
Vanity nameA custom, human-friendly string used to generate a vanity_url. Custom vanity URLs should not be used for sensitive content because they are easier to guess than standard shared links. string

Output

ParameterDescriptionData Type
Add shared link to folderThe shared link object created or updated for the folder.object
IdThe unique identifier of the folder.string
Path collection entries idThe ID of each folder in the path hierarchy leading to this folder. string
Created by idThe ID of the user who originally created the folder.string
Item collection entries file version idThe ID of the file version associated with an item returned in the item collection. string
Item collection entries idThe ID of each item returned in the folder’s item collection. string
Parent idThe ID of the parent folder.string
Owned by idThe ID of the user who owns the folder.string
Modified by idThe ID of the user who last modified the folder.string
  • In API workflows, a single response object is returned as the output. Any required fields can be extracted directly from this object.
  • In RPA workflows, some output parameters may differ, but the necessary values can still be retrieved from the response object even if they are not explicitly exposed.
  • Project compatibility
  • Overview
  • Input
  • Output

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo
Trust and Security
© 2005-2026 UiPath. All rights reserved.