Outline Wiki icon

Outline Wiki

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

Collection → Update

AI-generated

Summary

Update an existing Outline Wiki collection by specifying its UUID and modifying one or more of its properties.

Inputs

  • Collection ID (required) — The UUID of the collection to update.
  • Update Fields — Fields to update on the collection, including new name, description (Markdown supported), default member permission (Read Only or Read & Write), whether public sharing is allowed, color (hex code), and icon (name or emoji).

Output shape

a single JSON object containing the updated collection details as returned by the Outline API

Requires specifying the collection UUID; update fields are optional but at least one should be provided to modify the collection. The operation returns the API response JSON on successful update.

Examples

Example 1: Update collection name and description

Specify collectionId as the UUID of the target collection and set updateFields with new 'name' and 'description' strings.

Links

Discussion