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
Collections → Collections Add Group
AI-generatedSummary
Adds a group to an Outline collection with specified access permissions.
Inputs
- id (required) — The ID of the collection to which the group will be added.
- groupId (required) — The ID of the group being added to the collection.
- permission — The permission level granted to the group. Options are 'read' or 'read_write'. Defaults to 'read'.
- requestOptions — HTTP request settings including batching, proxy, timeout, and certificate validation options.
Output shape
a JSON object
Returns the API response indicating the outcome of assigning the group to the collection.
Examples
Example 1: Grant read access for a collection to a team group
Id: "col_12345", Group Id: "grp_67890", Permission: "read"
Example 2: Grant read-write access for a collection to an admin group
Id: "col_12345", Group Id: "grp_99999", Permission: "read_write"