Skip to navigation
Benchling APIFile

Update File

Beta
Update File.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

file_idstringRequired
ID of the File.

Headers

EARLY-ACCESSstringOptional

Set to true to access beta operations via /api/v3.

Request

This endpoint expects an object.
allowCustomFieldDeletionbooleanOptional
When true, custom fields present on the object but omitted from the update payload will be deleted. When false or omitted, omitting existing custom fields is an error. Defaults to false.
archiveReasonstringOptional
archivedbooleanOptional
expectedVersionIdstringOptional
The File's current version as last read by the caller. The update is rejected if another version has been published since.
filenamestringOptional

The name of the underlying file. Names the content of scratchFileId if given, otherwise renames the current version in place. Must not be blank, and its extension must not be blocked by the tenant’s file upload settings.

folderIdstringOptional
namestringOptional
scratchFileIdstringOptional

Response

OK
__typenamestringOptional
archiveReasonstring or nullOptional
archivedbooleanOptional
createdAtstringOptional
creatorobjectOptional
currentVersionIdstring or nullOptional
displayIdstring or nullOptional
folderobjectOptional
idstringOptional
modifiedAtstringOptional
namestring or nullOptional
scratchFileobjectOptional
versionsstringOptionalformat: "uri"
Published versions of the File, newest first.
externalFileIdstring or nullOptionalDeprecated
Use scratchFile to access externalFileId.
filenamestring or nullOptionalDeprecated
Use scratchFile to access filename.
mimeTypestring or nullOptionalDeprecated
Use scratchFile to access mimeType.

Errors

400
File Update Request Bad Request Error
403
File Update Request Forbidden Error
404
File Update Request Not Found Error
409
File Update Request Conflict Error
429
File Update Request Too Many Requests Error
500
File Update Request Internal Server Error