outline icon

outline

Interact with outline API

Actions107

Documents → Documents Update

AI-generated

Summary

Update a document in an Outline workspace

Inputs

  • id (required) — Unique identifier for the document. Either the UUID or the urlId is acceptable.
  • title — The title of the document.
  • text — The body of the document in markdown.
  • icon — Icon displayed alongside the document title
  • color — Color for the document icon (hex format)
  • fullWidth — Whether the document should be displayed in full width
  • templateId — Identifier for the template this document is based on
  • collectionId — Identifier for the collection to move the document to
  • insightsEnabled — Whether insights should be visible on the document
  • editMode — The editing mode for text updates to a document.
  • publish — Whether this document should be published and made visible to other workspace members, if a draft
  • dataAttributes — Data attributes to be updated. Attributes not included will be removed from the document.
  • requestOptions — Batching and other request configuration options for the API call.

Output shape

The updated document object from the Outline API (exact return shape not explicitly declared in properties or source)

All parameters are sent as JSON body to the Outline API. The id parameter is required; all others are optional with declared defaults. The editMode option controls whether text updates append, prepend, or replace the existing document body.

Links

Discussion