Outline Wiki icon

Outline Wiki

Interact with the Outline Wiki API — documents, collections, comments, attachments, users, shares

Actions31

Document → Archive

AI-generated

Summary

Archive a specific Outline Wiki document by providing its unique identifier, making the document restorable later.

Inputs

  • Document ID (required) — The UUID or URL slug (urlId) of the document to archive.

Output shape

a single JSON object representing the archived document state or API confirmation response

The operation returns the raw API response as JSON indicating success or details of the archived document. Errors are returned as messages if the operation fails.

Examples

Example 1: Archive an existing document

Set the resource to 'Document', the operation to 'Archive', and specify the document UUID or URL slug in the 'Document ID' field.

Links

Discussion