files

Update a file

Update a file. After you upload the file contents to S3, call this endpoint to mark the upload as SUCCEEDED. See Create a file for documentation of the full upload flow.

patch/files/{file_id}

Request

  • Base URL
    https://{tenant_name}.benchling.com/api/v2-beta
  • Auth
    HTTP bearer

Path parameters

file_idstring required

The ID of the file

Request body

customFieldsCustomFields
folderIdstring

ID of the folder that the file is moved into

uploadStatus'SUCCEEDED'

Response

OK

errorMessagestring nullable
uploadStatus'IN_PROGRESS' | 'SUCCEEDED' | 'FAILED_VALIDATION' | 'NOT_UPLOADED'
createdAtstring date-time

Date and time the file was created

customFieldsCustomFields
displayIdstring

User-friendly ID of the file

filenamestring
folderIdstring

ID of the folder that contains the file

idstring
modifiedAtstring date-time

Date and time the file was last modified

namestring

Changes

No recorded changes to this operation across all 1 revision of this API.