API ReferenceFiles

Update a file

Update a file, to change the workbook id for example

Path parameters

fileIdstringRequired
ID of file to update

Headers

AuthorizationstringRequired

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

X-Disable-Hooks"true"Required

Request

This endpoint expects an object.
workbookIdstringOptional
Workbook ID
namestringOptional
The name of the file
modeenumOptional
The storage mode of file to update
Allowed values:
statusenumOptional

Status of the file. Partial: File is uploaded but not yet processed. Analyzing: Smart Extract is running. Analyzed: Smart Extract has finished running. Complete: File has been extracted and is ready to be used. Archived: File has been archived. Purged: File has been purged. Failed: File has failed to be extracted.

actionslist of objectsOptional
The actions attached to the file

Response

This endpoint returns an object.
dataobject
Any uploaded file of any type

Errors