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 Add Group
AI-generatedSummary
Add a document to a group in Outline.
Inputs
- id (required) — Unique identifier for the document. Either the UUID or the urlId is acceptable.
- groupId (required) — Unique identifier for the group.
- permission — Permission level for the document in the group. Default: read. Options: read, read_write.
- requestOptions — Request configuration options.
- allowUnauthorizedCerts — Whether to accept the response even if SSL certificate validation is not possible. Default: false.
- proxy — HTTP proxy to use. If authentication is required it can be defined as: http://username:password@myproxy:3128. Default: empty string.
- timeout — Time in ms to wait for the server to send response headers before aborting the request. Default: 10000. Minimum: 1.
Output shape
The operation returns the result of the API call to add a document to a group. Exact return shape is not declared in the provided properties; describe based on declared inputs and typical API behavior.
Request options support batching: batchSize (number, default 50, -1 disables, 0 treated as 1) and batchInterval (number, default 1000 ms, 0 disabled).
Examples
Example 1: Add a document to a group with read permission and batching disabled.
id: 'doc-uuid-123', groupId: 'group-abc', permission: 'read', requestOptions: { batching: { batch: { batchSize: -1, batchInterval: 0 } } }