Skip to main content

Share folder

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 its id from listFolders or createFolder.
  • userId (integer, required): The member to share the folder with, or to unshare it from: their id from listMembers, which only owners and admins can call, or their userId in access from getFolder. 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. view lets them open its reports, edit also lets them change them, and manage also 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 of view, edit, manage.

Response 200

Success

application/json

  • userId (number, required): The member the folder is now shared with: the userId from the path.
  • permission (string, required): What the member can now do with the folder: the permission you sent. One of view, edit, manage.