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

​
Basic Parameters

ParameterDescription
DescriptionThe description for a file.
File IDThe unique identifier that represents a file.
NameAn optional different name for the file. The name should be provided with the extension name too.

​
Advanced Parameters

ParameterDescription
Disposition AtThe retention expiration timestamp for the given file.
Ensure Item Has Not ChangedEnsures this item hasn’t recently changed before making changes. 0 - not changed, 1 - changed.
Lock Download PreventedDefines if the file can be downloaded while it is locked.
Lock Expires AtDefines the time at which the lock expires.
Parent IDThe ID of parent item.
Permissions Can DownloadDefines who is allowed to download this file. open for everyone or company for the other members of the user’s enterprise.
Shared Link AccessThe 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).
Shared Link PasswordThe password required to access the shared link. Set the password to null to remove it.
Shared Link Permissions Can DownloadIf the shared link allows for downloading of files.
Shared Link Unshared AtThe timestamp at which this shared link will expire.
Shared Link Vanity NameDefines a custom vanity name to use in the shared link URL.
TagsThe tags for this item as a comma separated list.

​
Example Output

{
	"content_created_at": "2012-12-12T10:53:43-08:00",
	"content_modified_at": "2012-12-12T10:53:43-08:00",
	"created_at": "2012-12-12T10:53:43-08:00",
	"created_by": {
		"id": "11446498",
		"login": "ceo@example.com",
		"name": "Aaron Levie",
		"type": "user"
	},
	"description": "Contract for Q1 renewal",
	"etag": "1",
	"file_version": {
		"id": "12345",
		"sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc",
		"type": "file_version"
	},
	"id": "12345",
	"item_status": "active",
	"modified_at": "2012-12-12T10:53:43-08:00",
	"modified_by": {
		"id": "11446498",
		"login": "ceo@example.com",
		"name": "Aaron Levie",
		"type": "user"
	},
	"name": "Contract.pdf",
	"owned_by": {
		"id": "11446498",
		"login": "ceo@example.com",
		"name": "Aaron Levie",
		"type": "user"
	},
	"parent": {
		"etag": "1",
		"id": "12345",
		"name": "Contracts",
		"sequence_id": "3",
		"type": "folder"
	},
	"path_collection": {
		"entries": [
			{
				"etag": "1",
				"id": "12345",
				"name": "Contracts",
				"sequence_id": "3",
				"type": "folder"
			}
		],
		"total_count": 1
	},
	"purged_at": "2012-12-12T10:53:43-08:00",
	"sequence_id": "3",
	"sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
	"shared_link": {
		"access": "open",
		"download_count": 3,
		"download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
		"effective_access": "company",
		"effective_permission": "can_download",
		"is_password_enabled": true,
		"permissions": {
			"can_download": true,
			"can_edit": false,
			"can_preview": true
		},
		"preview_count": 3,
		"unshared_at": "2018-04-13T13:53:23-07:00",
		"url": "https://www.box.com/s/vspke7y05sb214wjokpk",
		"vanity_name": "my_url",
		"vanity_url": "https://acme.app.box.com/v/my_url/"
	},
	"size": 629644,
	"trashed_at": "2012-12-12T10:53:43-08:00",
	"type": "file"
}

​
Workflow Library Example

Update File with Box and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop