Updates a file. This can be used to rename or move a file, create a shared link, or lock a file.
nameAn optional different name for the file. This can be used to rename the file.
tagsarrayThe 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.
fieldsarrayA 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 u…
file_idRequiredstringThe unique identifier that represents 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`.
parent__idstringThe ID of a folder to move the file to. This can be used to move a file to a different location. For example, to move a file to the root folder, set this to '0'. Note: When passing parameters as JSON, use 'parent__id' (with double underscores).
collectionsarrayAn array of collections to make this file a member of. Currently we only support the `favorites` collection. To get the ID for a collection, use the [List all collections][1] endpoint. Passing an empty array `[]` or `null` will remove the file from all collections. [1]: e://get-…
descriptionstringThe 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.
lock__accessstringSet to 'lock' to create a lock on the file, preventing others from modifying it. To remove a lock, use an API call with lock set to null in the raw request. The only accepted value is 'lock'. Note: When passing parameters as JSON, use 'lock__access' (with double underscores).
disposition_atstringThe retention expiration timestamp for the given file. This date cannot be shortened once set on a file.
lock__expires__atstringDefines the time at which the lock expires. Note: When passing parameters as JSON, use 'lock__expires__at' (with double underscores).
permissions__can__downloadstringDefines 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 `com…
lock__is__download__preventedbooleanDefines if the file can be downloaded while it is locked. Note: When passing parameters as JSON, use 'lock__is__download__prevented' (with double underscores).
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
OAuth connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.