Update a file

Update a file, to change the workbook id for example

Path parameters

fileIdstringRequired

ID of file to update

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

1	import { FlatfileClient } from "@flatfile/api";
2
3	const client = new FlatfileClient({ token: "YOUR_TOKEN" });
4	await client.files.update("us_fl_YOUR_ID", {
5	name: "NewFileName"
6	});

1	{
2	"data": {
3	"id": "us_fl_YOUR_ID",
4	"name": "NewFileName",
5	"ext": "png",
6	"mimetype": "image/png",
7	"encoding": "7bit",
8	"status": "partial",
9	"size": 81953,
10	"bytesReceived": 81593,
11	"createdAt": "2023-11-15T19:31:33.015Z",
12	"updatedAt": "2023-11-15T19:31:33.015Z",
13	"spaceId": "us_sp_YOUR_ID",
14	"description": "This is a new test file",
15	"mode": "import"
16	}
17	}

Path parameters

Headers

Request

Response

Errors