Share folder
- OpenAPI 3.1.0 document: https://api.rollstack.com/public/v1/openapi.json
- The whole reference in Markdown: https://docs.rollstack.com/llms-full.txt
- An index of the reference: https://docs.rollstack.com/llms.txt
PUT https://api.rollstack.com/public/v1/folders/{id}/shares/{userId}
Shares a folder and everything in it with a member of the organization, or changes their permission, as Share in the app does. A member new to the folder gets an email. Needs manage on the folder, or owning it.
Requires the slide_decks:write scope.
Operation ID: shareFolder.
Path parameters
id(string, required): The folder to act on, by itsidfromlistFoldersorcreateFolder.userId(integer, required): The member to share the folder with, or to unshare it from: theiridfromlistMembers, which only owners and admins can call, or theiruserIdinaccessfromgetFolder. Only active members of the organization. Anyone the folder is shared with can unshare it from themselves.
Headers
Idempotency-Key(string): A unique value, such as a UUID, that makes retrying this call safe. A retry with the same key within 24 hours answers the first call's result instead of running it again. Use a new key for each new call. From 1 to 255 printable ASCII characters.
Request body, required
application/json
permission(string, required): What the member can do with the folder and everything in it.viewlets them open its reports,editalso lets them change them, andmanagealso lets them rename, move and share the folder and add folders to it. If the folder is already shared with the member, this replaces their permission and they aren't notified again. Rollstack also shares the files of its reports that update a Google Drive or OneDrive file with them, as the app does. One ofview,edit,manage.
Response 200
Success
application/json
userId(number, required): The member the folder is now shared with: theuserIdfrom the path.permission(string, required): What the member can now do with the folder: thepermissionyou sent. One ofview,edit,manage.