outline icon

outline

Interact with outline API

Actions107

Documents → Documents Unpublish

AI-generated

Summary

Unpublish a document in Outline by its unique identifier, with optional detachment from its collection and advanced request configuration.

Inputs

  • id (required) — Unique identifier for the document. Either the UUID or the urlId is acceptable.
  • detach — Whether to detach the document from the collection.
  • allowUnauthorizedCerts — Whether to accept the response even if SSL certificate validation is not possible.
  • proxy — HTTP proxy to use. If authentication is required it can be defined as follow: http://username:password@myproxy:3128
  • timeout — Time in ms to wait for the server to send response headers (and start the response body) before aborting the request
  • requestOptions — Advanced request configuration. Includes batching: Items per Batch (batchSize, number, -1 for disabled, 0 treated as 1), Batch Interval (batchInterval in ms, 0 for disabled).

Output shape

The Outline API response regarding the unpublish operation status.

Returned data shape is determined by the Outline API endpoint; not explicitly defined in the node's declared properties.

Examples

Example 1: Unpublish a document by UUID without detaching from its collection.

Set id to the document's UUID; leave detach false (default).

Example 2: Unpublish and detach a document from its collection.

Set id to the document's UUID; set detach to true.

Links

Discussion