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

Integration Service Activities

Last updated Feb 19, 2026

Add Shared Link to File

Project compatibility

Windows | Cross-platform

Overview

DescriptionAPI MethodAPI Path
Create a shared link for a file in Box.PUT/files/{file_id}/add_shared_link

Input

ParameterDescriptionData Type
FileThe file 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 users who are collaborators of the file or its parent folder
options
PasswordAn optional password required to access the shared link. Set to null to remove an existing password. Passwords must be at least 8 characters long and include a number, an uppercase letter, or a symbol. Password protection is only allowed when access = open. string
DownloadIndicates whether users can download the file via the shared link. This can only be enabled when access = open or company. boolean
PreviewIndicates whether users can preview the file through the shared link. This value is always true. For folder shared links, this applies to all items within the folder. boolean
Unshare timeOptional timestamp specifying when the shared link will automatically expire. date time
Shared link vanity nameA custom, human-friendly identifier used in the shared link's vanity_url. string

Output

ParameterDescriptionData Type
Add shared link to fileThe shared link object created or updated for the file.options
IdThe unique identifier of the file.string
Path collection entries idThe ID of each component in the file’s folder path hierarchy. string
Created by idThe ID of the user who originally created the file.string
Parent idThe ID of the parent folder that contains the file.string
Owned by idThe ID of the user who owns the file.string
Modified by idThe ID of the user who last modified the file.string
File Version IDThe ID of the version of the filestring
  • 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.