Add File Shared Link
add_file_shared_linkFull Description
Creates or updates a shared link on a file using the Box API (PUT /files/{file_id} with a shared_link object). If you omit all optional link fields, Box applies the enterprise default access level (send an empty shared_link).
Optional fields:
access:open|company|collaboratorspassword: set a string to require a password, ornullto removevanity_name: custom vanity segment (sensitive content should not use vanity URLs)unshared_at: when the link expires (paid accounts). Must be strictly in the future. Use an ISO 8601 string (e.g."2027-12-31T23:59:59Z"), Unix epoch seconds (10-digit string or number), or milliseconds (13-digit string or large number). Omit to leave unset.permissions.can_download: whether the shared link allows download (must be nested aspermissions:{ "can_download": false }; snake_case matches the Box API).
Public links (access: "open"): Password and unshared_at are required. Expiry must be within 90 days. Requests without both are rejected before calling Box.
Response: download_url is only included when Box reports effective_permission of can_download or can_edit. The underlying Box file object can still carry a download_url while the link is preview-only; this tool clears download_url in that case. Use effective_permission and permissions_can_download to see what was applied.
<examples> Default shared link: { "file_id": "123456789" }
Company-only with download: { "file_id": "123456789", "access": "company", "permissions": { "can_download": true } }
Public link (password + expiry required): { "file_id": "123456789", "access": "open", "password": "choose-a-strong-password", "unshared_at": "2026-09-07T23:59:59Z" } </examples>
Parameters (1 required, 5 optional)
file_idstringaccessstringopencompanycollaboratorspasswordstring/nullRequired when access is "open": non-empty password string.
permissionsobjectunshared_atstringRequired when access is "open": expiry within 90 days (ISO 8601, epoch seconds, or ms).
vanity_namestring