Comma-separated list of fields to include in the response. Use 'shared_link' to return the shared link information in the response.
web_link_idstring
Required
The ID of the web link.
shared__link__accessstring
The 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 folder (`collaborators`). If not set, this field defaults to the access level specified by the…
shared__link__passwordstring
The password required to access the shared link. Note: Password protection may not be supported for web links and could result in an error. If supported, passwords must be at least eight characters long and include a number, upper case letter, or a non-numeric or non-alphabetic…
shared__link__unshared__atstring
The 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__namestring
Defines 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__editboolean
If the shared link allows for editing. This parameter is not applicable to web links and will be ignored. It can only be set for files.
shared__link__permissions__can__previewboolean
If 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__downloadboolean
If the shared link allows for downloading of files. This can only be set when `access` is set to `open` or `company`.
Observable output
data
Required
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulboolean
Required
Whether or not the action execution was successful or not
Skills that use this Action
No published Skills explicitly reference this Action yet.