Archive document
archive-documentArchives a document, hiding it from the account's default document lists.
Use this tool when:
A document is no longer actively worked with and should be moved out of the way
The user asks to archive, hide, or clean up a document
Archiving does not delete anything: the document keeps all its data and can be restored later with the restore-document tool. The document must not already be archived.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| document_uuid | Yes | UUID of the document to archive. If you don't already have the document's UUID, use the list-documents tool to find it. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | URL to open the document in fynk | |
| name | No | Name of the document | |
| uuid | No | Unique identifier for the document. Do not show to the user unless they ask for it | |
| stage | No | What stage the document is in currently | |
| created_at | No | When the document was created. | |
| updated_at | No | When the document was last updated. | |
| archived_at | No | When the document was archived. Absent when the document is not archived. | |
| _entity_type | No | Only relevant for tooling. Do not show to the user | |
| document_type | No | If present, indicates what kind of document this is. Absent when the document has no type assigned |