Adds a shared link to a file.
fieldsExplicitly request the `shared_link` fields to be returned for this item. Defaults to 'shared_link' to return the shared link details in the response.
file_idRequiredstringThe unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.
shared__link__accessstringThe level of access for the shared link. This can be restricted to anyone with the link (`open`), only people within the company (`company`) and only those who have been invited to the file (`collaborators`). If not set, this field defaults to the access level specified by the e…
shared__link__passwordstringThe password required to access the shared link. Set the password to `null` to remove it. Passwords must now be at least eight characters long and include a number, upper case letter, or a non-numeric or non-alphabetic character. A password can only be set when `access` is set t…
shared__link__unshared__atstringThe timestamp at which this shared link will expire. This field can only be set by users with paid accounts. The value must be greater than the current date and time.
shared__link__vanity__namestringDefines a custom vanity name to use in the shared link URL, for example `https://app.box.com/v/my-shared-link`. Custom URLs should not be used when sharing sensitive content as vanity URLs are a lot easier to guess than regular shared links.
shared__link__permissions__can__editbooleanIf the shared link allows for editing of files. This can only be set when `access` is set to `open` or `company`. This value can only be `true` is `can_download` is also `true`.
shared__link__permissions__can__previewbooleanIf the shared link allows for previewing of files. This value is always `true`. For shared links on folders this also applies to any items in the folder.
shared__link__permissions__can__downloadbooleanIf the shared link allows for downloading of files. This can only be set when `access` is set to `open` or `company`.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
OAuth connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.