Share report
- 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/reports/{id}/shares/{userId}
Shares a report of any type with a member of the organization to view or edit it, or changes their permission. They get an email. A report that updates a file, such as a Google Slides presentation, also shares the file with them, as the app does.
Requires the slide_decks:write scope.
Operation ID: shareReport.
Path parameters
id(string, required): The report to act on, of anytype, by itsidfromlistReportsorcreateReport. You can also copy it from the report's link in Rollstack (appUrl): it's the part right after/slides/or/destinations/.userId(integer, required): The member to share the report with, or to unshare it from. Use theiridfromlistMembers, which only owners and admins can call, or theiruserIdinsharedWithfromgetReportif the report is already shared with them. You can share a report only with active members of the organization, and not with yourself. Anyone the report is shared with can unshare it from themselves, even withviewpermission.
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 report.viewlets them open, export and duplicate it.commentalso lets them add, reply to and resolve comments on its slides.editalso lets them change its slides, data, schedules, email and other settings, run it, send its email, chat with the slides agent about it, and manage who it's shared with. Neither lets them delete the report or transfer its ownership. If the report is already shared with the member, this replaces their permission and they aren't notified again. On a report that updates a file in Google Drive or OneDrive, Rollstack also shares the file with them, as the app does. One ofview,comment,edit.
Response 200
Success
application/json
userId(number, required): The member the report is now shared with: theuserIdfrom the path.permission(string, required): What the member can now do with the report: thepermissionyou sent. One ofview,comment,edit.