Loading…
Change visibility, direct download, public retention, and optional unlock protection on a file you own.
Same flow over HTTP: PATCH /files/share-settings
beecargo_update_share_settingsUse after upload, or when someone upgrades to Premium and wants forever retention or a new TTL. Set protect to create unlock credentials. Maps to PATCH /files/share-settings.
API key required. The file must be owned and claimed (not anonymous).
| Parameter | Type | Required | Description |
|---|---|---|---|
fileId | String | Yes | File id from the upload response |
visibility | unlisted | public | No | Public needs a claimed username on the account |
direct | Boolean | No | Premium only: auto-start download when the /d link opens |
retention | ttl | forever | No | Public + Premium only for forever |
expiresAt | String (ISO) | No | Expiry when retention is ttl |
protect | Boolean | No | When true, create a download unlock code and delivery link (returned once). When false, clear protection. |
handoffMessage | String | No | Optional note (max 480 chars) shown on the delivery link /h/{token} |
protect is on, the response includes unlockCode and handoffUrl once. Share both on a private channel. The /d link alone is not enough to download.handoffUrl (message + unlock) or type unlockCode on /d/{shortId}.