Actions107
- Attachments Actions
- Auth Actions
- Collections Actions
- Comments Actions
- Data Attributes Actions
- Documents Actions
- Documents Info
- Documents Import
- Documents Export
- Documents List
- Documents Documents
- Documents Drafts
- Documents Viewed
- Documents Answer Question
- Documents Search Titles
- Documents Search
- Documents Create
- Documents Update
- Documents Templatize
- Documents Unpublish
- Documents Move
- Documents Archive
- Documents Restore
- Documents Delete
- Documents Users
- Documents Memberships
- Documents Add User
- Documents Remove User
- Documents Archived
- Documents Deleted
- Documents Duplicate
- Documents Add Group
- Documents Remove Group
- Documents Group Memberships
- Documents Empty Trash
- Events Actions
- File Operations Actions
- Groups Actions
- O Auth Clients Actions
- O Auth Authentications Actions
- Revisions Actions
- Shares Actions
- Stars Actions
- Users Actions
- Templates Actions
- Views Actions
Documents → Documents Update
AI-generatedSummary
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
idparameter is required; all others are optional with declared defaults. TheeditModeoption controls whether text updates append, prepend, or replace the existing document body.