Search...
/
Community
Create Account
Sign in
Overview
Welcome
Authentication
Using Environments
API Reference
Accounts
Actions
Agents
Apps
Assistant
Commits
Data Retention Policies
Documents
Entitlements
Environments
Events
Files
GET
List files
POST
Upload a file
GET
Get a file
DEL
Delete a file
PATCH
Update a file
GET
Download a file
Guests
Jobs
Mapping
Records
Roles
Secrets
Sheets
Snapshots
Spaces
Users
Versions
Views
Workbooks
Community
Create Account
Sign in
API Reference
Files
Update a file
PATCH
https://api.x.flatfile.com/v1
/
files
/
:fileId
Update a file, to change the workbook id for example
Path parameters
fileId
string
Required
ID of file to update
Request
This endpoint expects an object.
workbookId
string
Optional
Workbook ID
name
string
Optional
The name of the file
mode
"import" or "export"
Optional
Allowed values:
import
export
The storage mode of file to update
status
enum
Optional
Allowed values:
partial
complete
archived
purged
failed
Status of the file
actions
list of objects
Optional
The actions attached to the file
Show 19 properties
Response
This endpoint returns an object.
data
object
Any uploaded file of any type
Show 17 properties
Errors
400
Bad Request
404
Not Found
Built with