/v1/files/{id}Rename or classify a file
Rename a file (name, trimmed, 1–255 characters, taken as given — keep the extension yourself) and/or say what a document IS: documentType from the closed vocabulary (bank_statement, tax_return, credit_report, contract, … other), the span it covers as YYYY-MM-DD periodStart/periodEnd, and statementStatus (new, submitted or fraud) on a bank statement. A body with only name renames and leaves the classification alone; any body without name is a classification, and each of its fields is read as given rather than merged, so an empty string puts the file back to unclassified. A word outside the vocabulary is refused rather than stored. Metadata only — nothing is sent to anybody and no storage is needed. Answers the file with its links and the caller's star.
Access class: workspace.
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Request body
application/jsonrequiredResponses
the action's answer
{
"data": {
"contentType": "string",
"createdAt": "2026-01-01T00:00:00Z",
"documentType": "string",
"folderId": "",
"id": "",
"landedAt": "2026-01-01T00:00:00Z",
"landingFailed": true,
"links": [
{
"definitionKey": "string",
"id": "",
"label": "string",
"rowId": ""
}
],
"name": "string",
"no_advertising": true,
"periodEnd": "string",
"periodStart": "string",
"rowId": "",
"sizeBytes": 1.5,
"source": "string",
"sourceDetail": "string",
"source_provider": "string",
"starred": true,
"statementStatus": "string",
"submissionUnavailableReason": "string",
"uploadedBy": 1.5
}
}a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}