Basic Parameters
| Parameter | Description |
|---|---|
| File ID | The unique identifier that represents a file. |
| Shared Link Access | The level of access for the shared link. This can be restricted to anyone with the link ( open), only peoplewithin the company ( company) and only those whohave been invited to the folder ( collaborators).accounts. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Shared Link Password | The password required to access the shared link. Set the password to null to remove it. |
| Shared Link Permissions Can Download | If the shared link allows for downloading of files. This can only be set when access is set toopen or company. |
| Shared Link Permissions Can Edit | If the shared link allows for editing of files. This can only be set when access is set toopen or company. |
| Shared Link Permissions Can Preview | If the shared link allows for previewing of files. This value is always true. For shared links on foldersthis also applies to any items in the folder. |
| Shared Link Unshared At | 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 Name | Defines a custom vanity name to use in the shared link URL, for example https://app.box.com/v/my-shared-link. |
Example Output
{
"value": {
"etag": "1",
"id": "12345",
"shared_link": {
"access": "open",
"download_count": 0,
"download_url": "https://app.box.com/shared/static/kwio6b4ovt1264rnfbyqo1.pdf",
"effective_access": "open",
"effective_permission": "can_download",
"is_password_enabled": false,
"permissions": {
"can_download": true,
"can_edit": true,
"can_preview": true
},
"preview_count": 0,
"unshared_at": "2020-09-21T10:34:41-07:00",
"url": "https://app.box.com/s/kwio6b4ovt1264rnfbyqo1",
"vanity_name": null,
"vanity_url": null
},
"type": "file"
}
}
Workflow Library Example
Update File Shared Link with Box and Send Results Via Email