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 User
AI-generatedSummary
Add a user to a specified Outline collection with assigned access permissions.
Inputs
- id (required) — Identifier for the target collection.
- userId (required) — Identifier for the user being added to the collection.
- permission — Permission level assigned to the user ('read' or 'read_write'). Defaults to 'read'.
- requestOptions — Additional HTTP request options, such as SSL certificate validation, proxy, timeout, and batching settings.
Output shape
a single JSON object
Returns the response payload from the Outline API confirming the added user assignment.
Examples
Example 1: Add a user to a collection with read-write access
Set Id to the collection ID, User Id to the target user ID, and Permission to 'Read Write'.
Example 2: Add a user with default read permissions
Set Id to the collection ID and User Id to the target user ID.