Box Developer Documentation
Log in

Update file

put
https://api.box.com/2.0
/files/:file_id

Updates a file. This can be used to rename or move a file, create a shared link, or lock a file.

Related Guides

Request

application/json

Path Parameters

stringin pathrequired
12345

The unique identifier that represent a file.

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

Query Parameters

string arrayin queryoptional
id,type,name

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.

Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

Request Body

stringin bodyoptional
The latest reports. Automatically updated256

The description for a file. This can be seen in the right-hand sidebar panel when viewing a file in the Box web app. Additionally, this index is used in the search index of the file, allowing users to find the file by the content in the description.

objectin body

Defines a lock on an item. This prevents the item from being moved, renamed, or otherwise changed by anyone other than the user who created the lock.

Set this to null to remove the lock.

stringnulloptional
lock

Value is always lock

string / date-timenulloptional
2012-12-12T10:53:43-08:00

Defines the time at which the lock expires.

booleannulloptional
true

Defines if the file can be downloaded while it is locked.

stringin bodyoptional
NewFile.txt

An optional different name for the file. This can be used to rename the file.

objectin body

An optional new parent folder for the file. This can be used to move the file to a new folder.

stringnulloptional
123

The ID of parent item

objectin body

Defines who can download a file.

stringnulloptional
open

Defines who is allowed to download this file. The possible values are either open for everyone or company for the other members of the user's enterprise.

This setting overrides the download permissions that are normally part of the role of a collaboration. When set to company, this essentially removes the download option for external users with viewer or editor a roles.

Value is one of open,company

objectin body

Defines a shared link for a file. Set this to null to remove the shared link.

stringnulloptional
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).

This field defaults to the default access level, which is the access level as specified by the enterprise admin.

The company access level is only available to paid accounts.

Value is one of default,open,company,collaborators

stringnulloptional
do-not-use-this-password

The password required to access the shared link. Set the password to null to remove it.

A password can only be set when access is set to open.

objectnull
booleannulloptional
true

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

string / date-timenulloptional
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.

string arrayin bodyoptional
["approved"]

The tags for this item. These tags are shown in the Box web app and mobile apps next to an item.

To add or remove a tag, retrieve the item's current tags, modify them, and then update this field.

There is a limit of 100 tags per item, and 10,000 unique tags per enterprise.

Request Headers

stringin header
optional
1

Ensures this item hasn't recently changed before making changes.

Pass in the item's last observed etag value into this header and the endpoint will fail with a 412 Precondition Failed if it has changed since.

Response

application/jsonFile

Returns a file object.

Not all available fields are returned by default. Use the fields query parameter to explicitly request any specific fields.

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.

  • access_denied_insufficient_permissions when the authenticated user does not have access the destination folder to move the file to.
application/jsonClient error

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

application/jsonClient error

Returned if the file_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 file. This indicates that the file has changed since it was last requested.

application/jsonClient error

An unexpected client error.

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

Request Example

cURL
curl -X PUT https://api.box.com/2.0/files/12345 \
     -H 'Authorization: Bearer <ACCESS_TOKEN>'
     -H 'Content-Type: application/json" '
     -d '{
       "name": "New name"
     }'
.NET
// Rename file 11111
var requestParams = new BoxFileRequest()
{
    Id = "11111",
    Name = "New name.pdf"
};
BoxFile updatedFile = await client.FilesManager.UpdateInformationAsync(requestParams);
Java
BoxFile file = new BoxFile(api, "id");
BoxFile.Info info = file.new Info();
info.setName("New Name");
file.updateInfo(info);
Python
file_id = '11111'
updated_file = client.file(file_id).update_info({'description': 'My file'})
Node
client.files.update('75937', { name : 'New name.pdf', fields: 'name' })
	.then(updatedFile => {
		/* updatedFile => {
			type: 'file',
			id: '11111',
			name: 'New name.pdf'
		}
		*/
	});
iOS
client.files.update(fileId: "11111", name: "New file name.docx") { (result: Result<File, BoxSDKError>) in
    guard case let .success(file) = result else {
        print("Error updating file information")
        return
    }

    print("File \(file.name) was updated at \(file.modifiedAt)")
}