API RestDocuments
Dernière mise à jour le 20 juillet 2026
Update user-editable metadata on a folder (description and/or tags).
Authorization
JwtAuth AuthorizationBearer <token>
In: header
Path Parameters
folder_id*Folder Id
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
User-editable metadata fields on a folder.
Response Body
application/json
curl -X PATCH "https://example.com/documents/folders/497f6eca-6276-4993-bfeb-53cbbbba6f08/metadata" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "document_type": "string", "document_profile": "string", "description": "string", "tags": [ "string" ], "status": "string", "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999", "is_favorite": false, "created_at": "2019-08-24T14:15:22Z", "creator": "string", "children": { "folders": [ { "is_favorite": true, "source": "string", "creator": "string", "my_access_level": "string", "documents_count": 0, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "document_type": "string", "document_profile": "string", "description": "string", "status": "DRAFT", "tags": [ null ], "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z" } ], "files": [ { "is_favorite": true, "source": "string", "creator": "string", "my_access_level": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "file_name": "string", "file_format": "string", "file_description": "string", "mime_type": "string", "file_size_bytes": 0, "upload_status": "AWAITING_UPLOAD", "parse_status": "PENDING", "indexing_status": "string", "created_at": "2019-08-24T14:15:22Z", "uploaded_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z" } ] }}Continuer plus loin
GETList Folder Files GET
Return only the files directly attached to one folder (no sub-folders).
DELETEPermanent Delete Folder DELETE
Permanently delete a folder and everything under it (sub-folders, files, S3 objects). Deletion is admin/integrator-only, independent of the caller's resolved access on the folder — see require_document_org_manager.