Box Developer Documentation
Log in
Latest version

Update shared link on folder

put
https://api.box.com/2.0
/folders/:folder_id

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.

Updates a shared link on a folder.

Request

bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
12345

The unique identifier that represent a folder.

The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123.

The root folder of a Box account is always represented by the ID 0.

Query Parameters

stringin queryrequired
shared_link

Explicitly request the shared_link fields to be returned for this item.

Request Body

objectin body

The settings for the shared link to update.

stringin bodyoptional
"open"

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 enterprise admin. To create a shared link with this default setting pass the shared_link object with no access field, for example { "shared_link": {} }.

The company access level is only available to paid accounts.

Value is one of open,company,collaborators

stringin bodyoptional
"do-n8t-use-this-Password"

The 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 to open.

objectin body
booleanin bodyoptional
true

If the shared link allows for downloading of files. This can only be set when access is set to open or company.

booleanin bodyoptional
false

This value can only be false for items with a type of folder.

booleanin bodyoptional
true

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.

string (date-time)in bodyoptional
"2012-12-12T10:53:43-08:00"

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.

stringin bodyoptional
"my-shared-link"

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.

Response

application/jsonFolder (Full)

Returns a basic representation of the folder, with the updated shared link attached.

application/jsonClient error

Returned when there is an incorrect permission combination

application/jsonClient error

Returned when the access token provided in the Authorization header is not recognized or not provided.

application/jsonClient error

Returned if the user does not have all the permissions to complete the update.

application/jsonClient error

Returned if the folder is not found, or the user does not have access to the folder.

application/jsonClient error

Returned if the folder_id is not in a recognized format.

application/jsonClient error

Returns an error when the If-Match header does not match the current etag value of the folder. This indicates that the folder has changed since it was last requested.

application/jsonClient error

An unexpected client error.

put
Update shared link on folder
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

cURL
curl -i -X PUT "https://api.box.com/2.0/folders/32423234?fields=shared_link" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -d '{
       "shared_link": {
         "access": "open",
         "password": "mypassword",
         "unshared_at": "2012-12-12T10:53:43-08:00",
         "permissions": {
           "can_download": false
         }
       }
     }'
TypeScript Gen
await client.sharedLinksFolders.updateSharedLinkOnFolder(
  folder.id,
  {
    sharedLink: {
      access:
        'collaborators' as UpdateSharedLinkOnFolderRequestBodySharedLinkAccessField,
    } satisfies UpdateSharedLinkOnFolderRequestBodySharedLinkField,
  } satisfies UpdateSharedLinkOnFolderRequestBody,
  { fields: 'shared_link' } satisfies UpdateSharedLinkOnFolderQueryParams,
);
Python Gen
client.shared_links_folders.update_shared_link_on_folder(
    folder.id,
    "shared_link",
    shared_link=UpdateSharedLinkOnFolderSharedLink(
        access=UpdateSharedLinkOnFolderSharedLinkAccessField.COLLABORATORS
    ),
)
.NET Gen
await client.SharedLinksFolders.UpdateSharedLinkOnFolderAsync(folderId: folder.Id, requestBody: new UpdateSharedLinkOnFolderRequestBody() { SharedLink = new UpdateSharedLinkOnFolderRequestBodySharedLinkField() { Access = UpdateSharedLinkOnFolderRequestBodySharedLinkAccessField.Collaborators } }, queryParams: new UpdateSharedLinkOnFolderQueryParams(fields: "shared_link"));
Swift Gen (Beta)
try await client.sharedLinksFolders.updateSharedLinkOnFolder(folderId: folder.id, requestBody: UpdateSharedLinkOnFolderRequestBody(sharedLink: UpdateSharedLinkOnFolderRequestBodySharedLinkField(access: UpdateSharedLinkOnFolderRequestBodySharedLinkAccessField.collaborators)), queryParams: UpdateSharedLinkOnFolderQueryParams(fields: "shared_link"))
Java
BoxFolder folder = new BoxFolder(api, "id");
BoxSharedLinkRequest sharedLinkRequest = new BoxSharedLinkRequest()
    .access(OPEN)
    .permissions(true, true);

BoxSharedLink sharedLink = folder.createSharedLink(sharedLinkRequest);

Response Example

{
  "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": false,
      "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": "folder"
}